1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: <?php
/**
* Copyright 2016 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
namespace LINE;
use LINE\LINEBot\Event\Parser\EventRequestParser;
use LINE\LINEBot\HTTPClient;
use LINE\LINEBot\MessageBuilder;
use LINE\LINEBot\MessageBuilder\TextMessageBuilder;
use LINE\LINEBot\Response;
use LINE\LINEBot\SignatureValidator;
use LINE\LINEBot\RichMenuBuilder;
use ReflectionClass;
/**
* A client class of LINE Messaging API.
*
* @package LINE
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class LINEBot
{
const DEFAULT_ENDPOINT_BASE = 'https://api.line.me';
/** @var string */
private $channelSecret;
/** @var string */
private $endpointBase;
/** @var HTTPClient */
private $httpClient;
/**
* LINEBot constructor.
*
* @param HTTPClient $httpClient HTTP client instance to use API calling.
* @param array $args Configurations.
*/
public function __construct(HTTPClient $httpClient, array $args)
{
$this->httpClient = $httpClient;
$this->channelSecret = $args['channelSecret'];
$this->endpointBase = LINEBot::DEFAULT_ENDPOINT_BASE;
if (array_key_exists('endpointBase', $args) && !empty($args['endpointBase'])) {
$this->endpointBase = $args['endpointBase'];
}
}
/**
* Gets specified user's profile through API calling.
*
* @param string $userId The user ID to retrieve profile.
* @return Response
*/
public function getProfile($userId)
{
return $this->httpClient->get($this->endpointBase . '/v2/bot/profile/' . urlencode($userId));
}
/**
* Gets message content which is associated with specified message ID.
*
* @param string $messageId The message ID to retrieve content.
* @return Response
*/
public function getMessageContent($messageId)
{
return $this->httpClient->get($this->endpointBase . '/v2/bot/message/' . urlencode($messageId) . '/content');
}
/**
* Replies arbitrary message to destination which is associated with reply token.
*
* @param string $replyToken Identifier of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function replyMessage($replyToken, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/reply', [
'replyToken' => $replyToken,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Replies text message(s) to destination which is associated with reply token.
*
* This method receives variable texts. It can send text(s) message as bulk.
*
* Exact signature of this method is <code>replyText(string $replyToken, string $text, string[] $extraTexts)</code>.
*
* Means, this method can also receive multiple texts like so;
*
* <code>
* $bot->replyText('reply-text', 'text', 'extra text1', 'extra text2', ...)
* </code>
*
* @param string $replyToken Identifier of destination.
* @param string $text Text of message.
* @param string[]|null $extraTexts Extra text of message.
* @return Response
* @throws \ReflectionException
*/
public function replyText($replyToken, $text, $extraTexts = null)
{
$extra = [];
if (!is_null($extraTexts)) {
$args = func_get_args();
$extra = array_slice($args, 2);
}
/** @var TextMessageBuilder $textMessageBuilder */
$ref = new ReflectionClass('LINE\LINEBot\MessageBuilder\TextMessageBuilder');
$textMessageBuilder = $ref->newInstanceArgs(array_merge([$text], $extra));
return $this->replyMessage($replyToken, $textMessageBuilder);
}
/**
* Sends arbitrary message to destination.
*
* @param string $to Identifier of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function pushMessage($to, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/push', [
'to' => $to,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Sends arbitrary message to multi destinations.
*
* @param array $tos Identifiers of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function multicast(array $tos, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/multicast', [
'to' => $tos,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Leaves from group.
*
* @param string $groupId Identifier of group to leave.
* @return Response
*/
public function leaveGroup($groupId)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/group/' . urlencode($groupId) . '/leave', []);
}
/**
* Leaves from room.
*
* @param string $roomId Identifier of room to leave.
* @return Response
*/
public function leaveRoom($roomId)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/room/' . urlencode($roomId) . '/leave', []);
}
/**
* Parse event request to Event objects.
*
* @param string $body Request body.
* @param string $signature Signature of request.
* @return LINEBot\Event\BaseEvent[]
* @throws LINEBot\Exception\InvalidEventRequestException
* @throws LINEBot\Exception\InvalidSignatureException
*/
public function parseEventRequest($body, $signature)
{
return EventRequestParser::parseEventRequest($body, $this->channelSecret, $signature);
}
/**
* Validate request with signature.
*
* @param string $body Request body.
* @param string $signature Signature of request.
* @return bool Request is valid or not.
* @throws LINEBot\Exception\InvalidSignatureException
*/
public function validateSignature($body, $signature)
{
return SignatureValidator::validateSignature($body, $this->channelSecret, $signature);
}
/**
* Gets the user profile of a member of a group that the bot is in.
* This can be the user ID of a user who has not added the bot as a friend or has blocked the bot.
*
* @param string $groupId Identifier of the group
* @param string $userId Identifier of the user
* @return Response
*/
public function getGroupMemberProfile($groupId, $userId)
{
$url = sprintf('%s/v2/bot/group/%s/member/%s', $this->endpointBase, urlencode($groupId), urlencode($userId));
return $this->httpClient->get($url, []);
}
/**
* Gets the user profile of a member of a room that the bot is in.
* This can be the user ID of a user who has not added the bot as a friend or has blocked the bot.
*
* @param string $roomId Identifier of the room
* @param string $userId Identifier of the user
* @return Response
*/
public function getRoomMemberProfile($roomId, $userId)
{
$url = sprintf('%s/v2/bot/room/%s/member/%s', $this->endpointBase, urlencode($roomId), urlencode($userId));
return $this->httpClient->get($url, []);
}
/**
* Gets the user IDs of the members of a group that the bot is in.
* This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
*
* This feature is only available for LINE@ Approved accounts or official accounts.
*
* @param string $groupId Identifier of the group
* @param string $start continuationToken
* @return Response
*/
public function getGroupMemberIds($groupId, $start = null)
{
$url = sprintf('%s/v2/bot/group/%s/members/ids', $this->endpointBase, urlencode($groupId));
$params = is_null($start) ? [] : ['start' => $start];
return $this->httpClient->get($url, $params);
}
/**
* Gets the user IDs of the members of a room that the bot is in.
* This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
*
* This feature is only available for LINE@ Approved accounts or official accounts.
*
* @param string $roomId Identifier of the room
* @param string $start continuationToken
* @return Response
*/
public function getRoomMemberIds($roomId, $start = null)
{
$url = sprintf('%s/v2/bot/room/%s/members/ids', $this->endpointBase, urlencode($roomId));
$params = is_null($start) ? [] : ['start' => $start];
return $this->httpClient->get($url, $params);
}
/**
* Gets the user IDs of the members of a group that the bot is in.
* This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
* This method gets all of the members by calling getGroupMemberIds() continually using token
*
* This feature is only available for LINE@ Approved accounts or official accounts.
*
* @param string $groupId Identifier of the group
* @return array memberIds
* @see \LINE\LINEBot::getGroupMemberIds()
*/
public function getAllGroupMemberIds($groupId)
{
$memberIds = [];
$continuationToken = null;
do {
$response = $this->getGroupMemberIds($groupId, $continuationToken);
$data = $response->getJSONDecodedBody();
$memberIds = array_merge($memberIds, $data['memberIds']);
$continuationToken = isset($data['next']) ? $data['next'] : null;
} while ($continuationToken);
return $memberIds;
}
/**
* Gets the user IDs of the members of a room that the bot is in.
* This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
* This method gets all of the members by calling getRoomMemberIds() continually using token
*
* This feature is only available for LINE@ Approved accounts or official accounts.
*
* @param string $roomId Identifier of the room
* @return array memberIds
* @see \LINE\LINEBot::getRoomMemberIds()
*/
public function getAllRoomMemberIds($roomId)
{
$memberIds = [];
$continuationToken = null;
do {
$response = $this->getRoomMemberIds($roomId, $continuationToken);
$data = $response->getJSONDecodedBody();
$memberIds = array_merge($memberIds, $data['memberIds']);
$continuationToken = isset($data['next']) ? $data['next'] : null;
} while ($continuationToken);
return $memberIds;
}
/**
* Gets a rich menu via a rich menu ID.
*
* @param string $richMenuId ID of an uploaded rich menu
* @return Response
*/
public function getRichMenu($richMenuId)
{
$url = sprintf('%s/v2/bot/richmenu/%s', $this->endpointBase, urlencode($richMenuId));
return $this->httpClient->get($url, []);
}
/**
* Creates a rich menu.
*
* You must upload a rich menu image and link the rich menu to a user for the rich menu to be displayed.
*
* @param RichMenuBuilder $richMenuBuilder
* @return Response
*/
public function createRichMenu($richMenuBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/richmenu', $richMenuBuilder->build());
}
/**
* Deletes a rich menu.
*
* @param string $richMenuId ID of an uploaded rich menu
* @return Response
*/
public function deleteRichMenu($richMenuId)
{
$url = sprintf('%s/v2/bot/richmenu/%s', $this->endpointBase, urlencode($richMenuId));
return $this->httpClient->delete($url);
}
/**
* Gets the ID of the rich menu linked to a user.
*
* @param string $userId User ID. Found in the source object of webhook event objects.
* @return Response
*/
public function getRichMenuId($userId)
{
$url = sprintf('%s/v2/bot/user/%s/richmenu', $this->endpointBase, urlencode($userId));
return $this->httpClient->get($url, []);
}
/**
* Links a rich menu to a user. Only one rich menu can be linked to a user at one time.
*
* @param string $userId User ID. Found in the source object of webhook event objects.
* @param string $richMenuId ID of an uploaded rich menu
* @return Response
*/
public function linkRichMenu($userId, $richMenuId)
{
$url = sprintf(
'%s/v2/bot/user/%s/richmenu/%s',
$this->endpointBase,
urlencode($userId),
urlencode($richMenuId)
);
return $this->httpClient->post($url, []);
}
/**
* Unlinks a rich menu from a user.
*
* @param string $userId User ID. Found in the source object of webhook event objects.
* @return Response
*/
public function unlinkRichMenu($userId)
{
$url = sprintf('%s/v2/bot/user/%s/richmenu', $this->endpointBase, urlencode($userId));
return $this->httpClient->delete($url);
}
/**
* Downloads an image associated with a rich menu.
*
* @param string $richMenuId ID of an uploaded rich menu
* @return Response
*/
public function downloadRichMenuImage($richMenuId)
{
$url = sprintf('%s/v2/bot/richmenu/%s/content', $this->endpointBase, urlencode($richMenuId));
return $this->httpClient->get($url);
}
/**
* Uploads and attaches an image to a rich menu.
*
* Notes:
* <ul><li>Images must have one of the following resolutions: 2500x1686 or 2500x843 pixels.</li>
* <li>You cannot replace an image attached to a rich menu. To update your rich menu image,
* create a new rich menu object and upload another image.</li></ul>
*
* @param string $richMenuId ID of an uploaded rich menu
* @param string $imagePath Path to the image
* @param string $contentType image/jpeg or image/png
* @return Response
*/
public function uploadRichMenuImage($richMenuId, $imagePath, $contentType)
{
$url = sprintf('%s/v2/bot/richmenu/%s/content', $this->endpointBase, urlencode($richMenuId));
return $this->httpClient->post(
$url,
[
'__file' => $imagePath,
'__type' => $contentType,
],
[ "Content-Type: $contentType" ]
);
}
/**
* Gets a list of all uploaded rich menus.
*
* @return Response
*/
public function getRichMenuList()
{
return $this->httpClient->get($this->endpointBase . '/v2/bot/richmenu/list');
}
}