linebot.v3.messaging.MessagingApi

All URIs are relative to https://api.line.me

Method	HTTP request	Description
broadcast	POST /v2/bot/message/broadcast
cancel_default_rich_menu	DELETE /v2/bot/user/all/richmenu
create_rich_menu	POST /v2/bot/richmenu
create_rich_menu_alias	POST /v2/bot/richmenu/alias
delete_rich_menu	DELETE /v2/bot/richmenu/{richMenuId}
delete_rich_menu_alias	DELETE /v2/bot/richmenu/alias/{richMenuAliasId}
get_aggregation_unit_name_list	GET /v2/bot/message/aggregation/list
get_aggregation_unit_usage	GET /v2/bot/message/aggregation/info
get_bot_info	GET /v2/bot/info
get_default_rich_menu_id	GET /v2/bot/user/all/richmenu
get_followers	GET /v2/bot/followers/ids
get_group_member_count	GET /v2/bot/group/{groupId}/members/count
get_group_member_profile	GET /v2/bot/group/{groupId}/member/{userId}
get_group_members_ids	GET /v2/bot/group/{groupId}/members/ids
get_group_summary	GET /v2/bot/group/{groupId}/summary
get_joined_membership_users	GET /v2/bot/membership/{membershipId}/users/ids
get_membership_list	GET /v2/bot/membership/list
get_membership_subscription	GET /v2/bot/membership/subscription/{userId}
get_message_quota	GET /v2/bot/message/quota
get_message_quota_consumption	GET /v2/bot/message/quota/consumption
get_narrowcast_progress	GET /v2/bot/message/progress/narrowcast
get_number_of_sent_broadcast_messages	GET /v2/bot/message/delivery/broadcast
get_number_of_sent_multicast_messages	GET /v2/bot/message/delivery/multicast
get_number_of_sent_push_messages	GET /v2/bot/message/delivery/push
get_number_of_sent_reply_messages	GET /v2/bot/message/delivery/reply
get_pnp_message_statistics	GET /v2/bot/message/delivery/pnp
get_profile	GET /v2/bot/profile/{userId}
get_rich_menu	GET /v2/bot/richmenu/{richMenuId}
get_rich_menu_alias	GET /v2/bot/richmenu/alias/{richMenuAliasId}
get_rich_menu_alias_list	GET /v2/bot/richmenu/alias/list
get_rich_menu_batch_progress	GET /v2/bot/richmenu/progress/batch
get_rich_menu_id_of_user	GET /v2/bot/user/{userId}/richmenu
get_rich_menu_list	GET /v2/bot/richmenu/list
get_room_member_count	GET /v2/bot/room/{roomId}/members/count
get_room_member_profile	GET /v2/bot/room/{roomId}/member/{userId}
get_room_members_ids	GET /v2/bot/room/{roomId}/members/ids
get_webhook_endpoint	GET /v2/bot/channel/webhook/endpoint
issue_link_token	POST /v2/bot/user/{userId}/linkToken
leave_group	POST /v2/bot/group/{groupId}/leave
leave_room	POST /v2/bot/room/{roomId}/leave
link_rich_menu_id_to_user	POST /v2/bot/user/{userId}/richmenu/{richMenuId}
link_rich_menu_id_to_users	POST /v2/bot/richmenu/bulk/link
mark_messages_as_read	POST /v2/bot/message/markAsRead
multicast	POST /v2/bot/message/multicast
narrowcast	POST /v2/bot/message/narrowcast
push_message	POST /v2/bot/message/push
push_messages_by_phone	POST /bot/pnp/push
reply_message	POST /v2/bot/message/reply
rich_menu_batch	POST /v2/bot/richmenu/batch
set_default_rich_menu	POST /v2/bot/user/all/richmenu/{richMenuId}
set_webhook_endpoint	PUT /v2/bot/channel/webhook/endpoint
show_loading_animation	POST /v2/bot/chat/loading/start
test_webhook_endpoint	POST /v2/bot/channel/webhook/test
unlink_rich_menu_id_from_user	DELETE /v2/bot/user/{userId}/richmenu
unlink_rich_menu_id_from_users	POST /v2/bot/richmenu/bulk/unlink
update_rich_menu_alias	POST /v2/bot/richmenu/alias/{richMenuAliasId}
validate_broadcast	POST /v2/bot/message/validate/broadcast
validate_multicast	POST /v2/bot/message/validate/multicast
validate_narrowcast	POST /v2/bot/message/validate/narrowcast
validate_push	POST /v2/bot/message/validate/push
validate_reply	POST /v2/bot/message/validate/reply
validate_rich_menu_batch_request	POST /v2/bot/richmenu/validate/batch
validate_rich_menu_object	POST /v2/bot/richmenu/validate

broadcast

object broadcast(broadcast_request, x_line_retry_key=x_line_retry_key)

Sends a message to multiple users at any time.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.broadcast_request import BroadcastRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    broadcast_request = linebot.v3.messaging.BroadcastRequest() # BroadcastRequest | 
    x_line_retry_key = 'x_line_retry_key_example' # str | Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.  (optional)

    try:
        api_response = api_instance.broadcast(broadcast_request, x_line_retry_key=x_line_retry_key)
        print("The response of MessagingApi->broadcast:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->broadcast: %s\n" % e)

Parameters

Name	Type	Description	Notes
broadcast_request	BroadcastRequest
x_line_retry_key	str	Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.	[optional]

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_default_rich_menu

cancel_default_rich_menu()

Cancel default rich menu

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_instance.cancel_default_rich_menu()
    except Exception as e:
        print("Exception when calling MessagingApi->cancel_default_rich_menu: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_rich_menu

RichMenuIdResponse create_rich_menu(rich_menu_request)

Create rich menu

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_id_response import RichMenuIdResponse
from linebot.v3.messaging.models.rich_menu_request import RichMenuRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_request = linebot.v3.messaging.RichMenuRequest() # RichMenuRequest | 

    try:
        api_response = api_instance.create_rich_menu(rich_menu_request)
        print("The response of MessagingApi->create_rich_menu:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->create_rich_menu: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_request	RichMenuRequest

Return type

RichMenuIdResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_rich_menu_alias

create_rich_menu_alias(create_rich_menu_alias_request)

Create rich menu alias

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.create_rich_menu_alias_request import CreateRichMenuAliasRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    create_rich_menu_alias_request = linebot.v3.messaging.CreateRichMenuAliasRequest() # CreateRichMenuAliasRequest | 

    try:
        api_instance.create_rich_menu_alias(create_rich_menu_alias_request)
    except Exception as e:
        print("Exception when calling MessagingApi->create_rich_menu_alias: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_rich_menu_alias_request	CreateRichMenuAliasRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_rich_menu

delete_rich_menu(rich_menu_id)

Deletes a rich menu.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_id = 'rich_menu_id_example' # str | ID of a rich menu

    try:
        api_instance.delete_rich_menu(rich_menu_id)
    except Exception as e:
        print("Exception when calling MessagingApi->delete_rich_menu: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_id	str	ID of a rich menu

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_rich_menu_alias

delete_rich_menu_alias(rich_menu_alias_id)

Delete rich menu alias

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_alias_id = 'rich_menu_alias_id_example' # str | Rich menu alias ID that you want to delete.

    try:
        api_instance.delete_rich_menu_alias(rich_menu_alias_id)
    except Exception as e:
        print("Exception when calling MessagingApi->delete_rich_menu_alias: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_alias_id	str	Rich menu alias ID that you want to delete.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_aggregation_unit_name_list

GetAggregationUnitNameListResponse get_aggregation_unit_name_list(limit=limit, start=start)

Get name list of units used this month

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_aggregation_unit_name_list_response import GetAggregationUnitNameListResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    limit = 'limit_example' # str | The maximum number of aggregation units you can get per request.  (optional)
    start = 'start_example' # str | Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.  (optional)

    try:
        api_response = api_instance.get_aggregation_unit_name_list(limit=limit, start=start)
        print("The response of MessagingApi->get_aggregation_unit_name_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_aggregation_unit_name_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	str	The maximum number of aggregation units you can get per request.	[optional]
start	str	Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.	[optional]

Return type

GetAggregationUnitNameListResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_aggregation_unit_usage

GetAggregationUnitUsageResponse get_aggregation_unit_usage()

Get number of units used this month

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_aggregation_unit_usage_response import GetAggregationUnitUsageResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_aggregation_unit_usage()
        print("The response of MessagingApi->get_aggregation_unit_usage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_aggregation_unit_usage: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetAggregationUnitUsageResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_bot_info

BotInfoResponse get_bot_info()

Get bot info

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.bot_info_response import BotInfoResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_bot_info()
        print("The response of MessagingApi->get_bot_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_bot_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BotInfoResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_default_rich_menu_id

RichMenuIdResponse get_default_rich_menu_id()

Gets the ID of the default rich menu set with the Messaging API.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_id_response import RichMenuIdResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_default_rich_menu_id()
        print("The response of MessagingApi->get_default_rich_menu_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_default_rich_menu_id: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RichMenuIdResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_followers

GetFollowersResponse get_followers(start=start, limit=limit)

Get a list of users who added your LINE Official Account as a friend

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_followers_response import GetFollowersResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    start = 'start_example' # str | Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.  (optional)
    limit = 300 # int | The maximum number of user IDs to retrieve in a single request. (optional) (default to 300)

    try:
        api_response = api_instance.get_followers(start=start, limit=limit)
        print("The response of MessagingApi->get_followers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_followers: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	str	Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.	[optional]
limit	int	The maximum number of user IDs to retrieve in a single request.	[optional] [default to 300]

Return type

GetFollowersResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group_member_count

GroupMemberCountResponse get_group_member_count(group_id)

Get number of users in a group chat

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.group_member_count_response import GroupMemberCountResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    group_id = 'group_id_example' # str | Group ID

    try:
        api_response = api_instance.get_group_member_count(group_id)
        print("The response of MessagingApi->get_group_member_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_group_member_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	Group ID

Return type

GroupMemberCountResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group_member_profile

GroupUserProfileResponse get_group_member_profile(group_id, user_id)

Get group chat member profile

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.group_user_profile_response import GroupUserProfileResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    group_id = 'group_id_example' # str | Group ID
    user_id = 'user_id_example' # str | User ID

    try:
        api_response = api_instance.get_group_member_profile(group_id, user_id)
        print("The response of MessagingApi->get_group_member_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_group_member_profile: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	Group ID
user_id	str	User ID

Return type

GroupUserProfileResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group_members_ids

MembersIdsResponse get_group_members_ids(group_id, start=start)

Get group chat member user IDs

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.members_ids_response import MembersIdsResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    group_id = 'group_id_example' # str | Group ID
    start = 'start_example' # str | Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.  (optional)

    try:
        api_response = api_instance.get_group_members_ids(group_id, start=start)
        print("The response of MessagingApi->get_group_members_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_group_members_ids: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	Group ID
start	str	Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.	[optional]

Return type

MembersIdsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group_summary

GroupSummaryResponse get_group_summary(group_id)

Get group chat summary

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.group_summary_response import GroupSummaryResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    group_id = 'group_id_example' # str | Group ID

    try:
        api_response = api_instance.get_group_summary(group_id)
        print("The response of MessagingApi->get_group_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_group_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	Group ID

Return type

GroupSummaryResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_joined_membership_users

GetJoinedMembershipUsersResponse get_joined_membership_users(membership_id, start=start, limit=limit)

Get a list of user IDs who joined the membership.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_joined_membership_users_response import GetJoinedMembershipUsersResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    membership_id = 56 # int | Membership plan ID.
    start = 'start_example' # str | A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).  (optional)
    limit = 300 # int | The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.  (optional) (default to 300)

    try:
        api_response = api_instance.get_joined_membership_users(membership_id, start=start, limit=limit)
        print("The response of MessagingApi->get_joined_membership_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_joined_membership_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
membership_id	int	Membership plan ID.
start	str	A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).	[optional]
limit	int	The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.	[optional] [default to 300]

Return type

GetJoinedMembershipUsersResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	`start` is incorrect or expired, or `limit` is under 1 or over 1000.	-
404	Membership ID is not owned by the bot or does not exist.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_membership_list

MembershipListResponse get_membership_list()

Get a list of memberships.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.membership_list_response import MembershipListResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_membership_list()
        print("The response of MessagingApi->get_membership_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_membership_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MembershipListResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Unable to get information about the memberships.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_membership_subscription

GetMembershipSubscriptionResponse get_membership_subscription(user_id)

Get a user's membership subscription.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_membership_subscription_response import GetMembershipSubscriptionResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID

    try:
        api_response = api_instance.get_membership_subscription(user_id)
        print("The response of MessagingApi->get_membership_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_membership_subscription: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID

Return type

GetMembershipSubscriptionResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	An invalid user ID is specified.	-
404	Unable to get information about the membership to which the user subscribes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_message_quota

MessageQuotaResponse get_message_quota()

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.message_quota_response import MessageQuotaResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_message_quota()
        print("The response of MessagingApi->get_message_quota:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_message_quota: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MessageQuotaResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_message_quota_consumption

QuotaConsumptionResponse get_message_quota_consumption()

Gets the number of messages sent in the current month.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.quota_consumption_response import QuotaConsumptionResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_message_quota_consumption()
        print("The response of MessagingApi->get_message_quota_consumption:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_message_quota_consumption: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

QuotaConsumptionResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_narrowcast_progress

NarrowcastProgressResponse get_narrowcast_progress(request_id)

Gets the status of a narrowcast message.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.narrowcast_progress_response import NarrowcastProgressResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    request_id = 'request_id_example' # str | The narrowcast message's request ID. Each Messaging API request has a request ID.

    try:
        api_response = api_instance.get_narrowcast_progress(request_id)
        print("The response of MessagingApi->get_narrowcast_progress:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_narrowcast_progress: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_id	str	The narrowcast message's request ID. Each Messaging API request has a request ID.

Return type

NarrowcastProgressResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_number_of_sent_broadcast_messages

NumberOfMessagesResponse get_number_of_sent_broadcast_messages(var_date)

Get number of sent broadcast messages

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    var_date = 'var_date_example' # str | Date the messages were sent  Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 

    try:
        api_response = api_instance.get_number_of_sent_broadcast_messages(var_date)
        print("The response of MessagingApi->get_number_of_sent_broadcast_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_number_of_sent_broadcast_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_date	str	Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Return type

NumberOfMessagesResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_number_of_sent_multicast_messages

NumberOfMessagesResponse get_number_of_sent_multicast_messages(var_date)

Get number of sent multicast messages

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    var_date = 'var_date_example' # str | Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9 

    try:
        api_response = api_instance.get_number_of_sent_multicast_messages(var_date)
        print("The response of MessagingApi->get_number_of_sent_multicast_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_number_of_sent_multicast_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_date	str	Date the messages were sent Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Return type

NumberOfMessagesResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_number_of_sent_push_messages

NumberOfMessagesResponse get_number_of_sent_push_messages(var_date)

Get number of sent push messages

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    var_date = 'var_date_example' # str | Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9 

    try:
        api_response = api_instance.get_number_of_sent_push_messages(var_date)
        print("The response of MessagingApi->get_number_of_sent_push_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_number_of_sent_push_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_date	str	Date the messages were sent Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Return type

NumberOfMessagesResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_number_of_sent_reply_messages

NumberOfMessagesResponse get_number_of_sent_reply_messages(var_date)

Get number of sent reply messages

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    var_date = 'var_date_example' # str | Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9 

    try:
        api_response = api_instance.get_number_of_sent_reply_messages(var_date)
        print("The response of MessagingApi->get_number_of_sent_reply_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_number_of_sent_reply_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_date	str	Date the messages were sent Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9

Return type

NumberOfMessagesResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_pnp_message_statistics

NumberOfMessagesResponse get_pnp_message_statistics(var_date)

Get number of sent LINE notification messages　

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    var_date = 'var_date_example' # str | Date the message was sent  Format: `yyyyMMdd` (Example:`20211231`) Time zone: UTC+9 

    try:
        api_response = api_instance.get_pnp_message_statistics(var_date)
        print("The response of MessagingApi->get_pnp_message_statistics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_pnp_message_statistics: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_date	str	Date the message was sent Format: `yyyyMMdd` (Example:`20211231`) Time zone: UTC+9

Return type

NumberOfMessagesResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_profile

UserProfileResponse get_profile(user_id)

Get profile

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.user_profile_response import UserProfileResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID

    try:
        api_response = api_instance.get_profile(user_id)
        print("The response of MessagingApi->get_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_profile: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID

Return type

UserProfileResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu

RichMenuResponse get_rich_menu(rich_menu_id)

Gets a rich menu via a rich menu ID.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_response import RichMenuResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_id = 'rich_menu_id_example' # str | ID of a rich menu

    try:
        api_response = api_instance.get_rich_menu(rich_menu_id)
        print("The response of MessagingApi->get_rich_menu:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_id	str	ID of a rich menu

Return type

RichMenuResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu_alias

RichMenuAliasResponse get_rich_menu_alias(rich_menu_alias_id)

Get rich menu alias information

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_alias_response import RichMenuAliasResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_alias_id = 'rich_menu_alias_id_example' # str | The rich menu alias ID whose information you want to obtain.

    try:
        api_response = api_instance.get_rich_menu_alias(rich_menu_alias_id)
        print("The response of MessagingApi->get_rich_menu_alias:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu_alias: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_alias_id	str	The rich menu alias ID whose information you want to obtain.

Return type

RichMenuAliasResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu_alias_list

RichMenuAliasListResponse get_rich_menu_alias_list()

Get list of rich menu alias

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_alias_list_response import RichMenuAliasListResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_rich_menu_alias_list()
        print("The response of MessagingApi->get_rich_menu_alias_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu_alias_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RichMenuAliasListResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu_batch_progress

RichMenuBatchProgressResponse get_rich_menu_batch_progress(request_id)

Get the status of Replace or unlink a linked rich menus in batches.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_batch_progress_response import RichMenuBatchProgressResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    request_id = 'request_id_example' # str | A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

    try:
        api_response = api_instance.get_rich_menu_batch_progress(request_id)
        print("The response of MessagingApi->get_rich_menu_batch_progress:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu_batch_progress: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_id	str	A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Return type

RichMenuBatchProgressResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu_id_of_user

RichMenuIdResponse get_rich_menu_id_of_user(user_id)

Get rich menu ID of user

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_id_response import RichMenuIdResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.

    try:
        api_response = api_instance.get_rich_menu_id_of_user(user_id)
        print("The response of MessagingApi->get_rich_menu_id_of_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu_id_of_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.

Return type

RichMenuIdResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rich_menu_list

RichMenuListResponse get_rich_menu_list()

Get rich menu list

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_list_response import RichMenuListResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_rich_menu_list()
        print("The response of MessagingApi->get_rich_menu_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_rich_menu_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RichMenuListResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_room_member_count

RoomMemberCountResponse get_room_member_count(room_id)

Get number of users in a multi-person chat

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.room_member_count_response import RoomMemberCountResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    room_id = 'room_id_example' # str | Room ID

    try:
        api_response = api_instance.get_room_member_count(room_id)
        print("The response of MessagingApi->get_room_member_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_room_member_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
room_id	str	Room ID

Return type

RoomMemberCountResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_room_member_profile

RoomUserProfileResponse get_room_member_profile(room_id, user_id)

Get multi-person chat member profile

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.room_user_profile_response import RoomUserProfileResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    room_id = 'room_id_example' # str | Room ID
    user_id = 'user_id_example' # str | User ID

    try:
        api_response = api_instance.get_room_member_profile(room_id, user_id)
        print("The response of MessagingApi->get_room_member_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_room_member_profile: %s\n" % e)

Parameters

Name	Type	Description	Notes
room_id	str	Room ID
user_id	str	User ID

Return type

RoomUserProfileResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_room_members_ids

MembersIdsResponse get_room_members_ids(room_id, start=start)

Get multi-person chat member user IDs

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.members_ids_response import MembersIdsResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    room_id = 'room_id_example' # str | Room ID
    start = 'start_example' # str | Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.  (optional)

    try:
        api_response = api_instance.get_room_members_ids(room_id, start=start)
        print("The response of MessagingApi->get_room_members_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_room_members_ids: %s\n" % e)

Parameters

Name	Type	Description	Notes
room_id	str	Room ID
start	str	Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.	[optional]

Return type

MembersIdsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhook_endpoint

GetWebhookEndpointResponse get_webhook_endpoint()

Get webhook endpoint information

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.get_webhook_endpoint_response import GetWebhookEndpointResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)

    try:
        api_response = api_instance.get_webhook_endpoint()
        print("The response of MessagingApi->get_webhook_endpoint:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->get_webhook_endpoint: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetWebhookEndpointResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

issue_link_token

IssueLinkTokenResponse issue_link_token(user_id)

Issue link token

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.issue_link_token_response import IssueLinkTokenResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID for the LINE account to be linked. Found in the `source` object of account link event objects. Do not use the LINE ID used in LINE. 

    try:
        api_response = api_instance.issue_link_token(user_id)
        print("The response of MessagingApi->issue_link_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->issue_link_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID for the LINE account to be linked. Found in the `source` object of account link event objects. Do not use the LINE ID used in LINE.

Return type

IssueLinkTokenResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leave_group

leave_group(group_id)

Leave group chat

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    group_id = 'group_id_example' # str | Group ID

    try:
        api_instance.leave_group(group_id)
    except Exception as e:
        print("Exception when calling MessagingApi->leave_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	Group ID

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leave_room

leave_room(room_id)

Leave multi-person chat

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    room_id = 'room_id_example' # str | Room ID

    try:
        api_instance.leave_room(room_id)
    except Exception as e:
        print("Exception when calling MessagingApi->leave_room: %s\n" % e)

Parameters

Name	Type	Description	Notes
room_id	str	Room ID

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_rich_menu_id_to_user

link_rich_menu_id_to_user(user_id, rich_menu_id)

Link rich menu to user.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
    rich_menu_id = 'rich_menu_id_example' # str | ID of a rich menu

    try:
        api_instance.link_rich_menu_id_to_user(user_id, rich_menu_id)
    except Exception as e:
        print("Exception when calling MessagingApi->link_rich_menu_id_to_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
rich_menu_id	str	ID of a rich menu

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_rich_menu_id_to_users

link_rich_menu_id_to_users(rich_menu_bulk_link_request)

Link rich menu to multiple users

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_bulk_link_request import RichMenuBulkLinkRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_bulk_link_request = linebot.v3.messaging.RichMenuBulkLinkRequest() # RichMenuBulkLinkRequest | 

    try:
        api_instance.link_rich_menu_id_to_users(rich_menu_bulk_link_request)
    except Exception as e:
        print("Exception when calling MessagingApi->link_rich_menu_id_to_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_bulk_link_request	RichMenuBulkLinkRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
202	Accepted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mark_messages_as_read

mark_messages_as_read(mark_messages_as_read_request)

Mark messages from users as read

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.mark_messages_as_read_request import MarkMessagesAsReadRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    mark_messages_as_read_request = {"chat":{"userId":"Uxxxxxxxxxxxxxxxxxx"}} # MarkMessagesAsReadRequest | 

    try:
        api_instance.mark_messages_as_read(mark_messages_as_read_request)
    except Exception as e:
        print("Exception when calling MessagingApi->mark_messages_as_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
mark_messages_as_read_request	MarkMessagesAsReadRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

multicast

object multicast(multicast_request, x_line_retry_key=x_line_retry_key)

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.multicast_request import MulticastRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    multicast_request = linebot.v3.messaging.MulticastRequest() # MulticastRequest | 
    x_line_retry_key = 'x_line_retry_key_example' # str | Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.  (optional)

    try:
        api_response = api_instance.multicast(multicast_request, x_line_retry_key=x_line_retry_key)
        print("The response of MessagingApi->multicast:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->multicast: %s\n" % e)

Parameters

Name	Type	Description	Notes
multicast_request	MulticastRequest
x_line_retry_key	str	Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.	[optional]

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

narrowcast

object narrowcast(narrowcast_request, x_line_retry_key=x_line_retry_key)

Send narrowcast message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.narrowcast_request import NarrowcastRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    narrowcast_request = linebot.v3.messaging.NarrowcastRequest() # NarrowcastRequest | 
    x_line_retry_key = 'x_line_retry_key_example' # str | Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.  (optional)

    try:
        api_response = api_instance.narrowcast(narrowcast_request, x_line_retry_key=x_line_retry_key)
        print("The response of MessagingApi->narrowcast:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->narrowcast: %s\n" % e)

Parameters

Name	Type	Description	Notes
narrowcast_request	NarrowcastRequest
x_line_retry_key	str	Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.	[optional]

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

push_message

PushMessageResponse push_message(push_message_request, x_line_retry_key=x_line_retry_key)

Sends a message to a user, group chat, or multi-person chat at any time.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.push_message_request import PushMessageRequest
from linebot.v3.messaging.models.push_message_response import PushMessageResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    push_message_request = linebot.v3.messaging.PushMessageRequest() # PushMessageRequest | 
    x_line_retry_key = 'x_line_retry_key_example' # str | Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.  (optional)

    try:
        api_response = api_instance.push_message(push_message_request, x_line_retry_key=x_line_retry_key)
        print("The response of MessagingApi->push_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->push_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
push_message_request	PushMessageRequest
x_line_retry_key	str	Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.	[optional]

Return type

PushMessageResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

push_messages_by_phone

push_messages_by_phone(pnp_messages_request, x_line_delivery_tag=x_line_delivery_tag)

Send LINE notification message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.pnp_messages_request import PnpMessagesRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    pnp_messages_request = linebot.v3.messaging.PnpMessagesRequest() # PnpMessagesRequest | 
    x_line_delivery_tag = 'x_line_delivery_tag_example' # str | String returned in the delivery.data property of the delivery completion event via Webhook. (optional)

    try:
        api_instance.push_messages_by_phone(pnp_messages_request, x_line_delivery_tag=x_line_delivery_tag)
    except Exception as e:
        print("Exception when calling MessagingApi->push_messages_by_phone: %s\n" % e)

Parameters

Name	Type	Description	Notes
pnp_messages_request	PnpMessagesRequest
x_line_delivery_tag	str	String returned in the delivery.data property of the delivery completion event via Webhook.	[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
422	Unprocessable Entity	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reply_message

ReplyMessageResponse reply_message(reply_message_request)

Send reply message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.reply_message_request import ReplyMessageRequest
from linebot.v3.messaging.models.reply_message_response import ReplyMessageResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    reply_message_request = linebot.v3.messaging.ReplyMessageRequest() # ReplyMessageRequest | 

    try:
        api_response = api_instance.reply_message(reply_message_request)
        print("The response of MessagingApi->reply_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->reply_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
reply_message_request	ReplyMessageRequest

Return type

ReplyMessageResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad request	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rich_menu_batch

rich_menu_batch(rich_menu_batch_request)

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_batch_request import RichMenuBatchRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_batch_request = linebot.v3.messaging.RichMenuBatchRequest() # RichMenuBatchRequest | 

    try:
        api_instance.rich_menu_batch(rich_menu_batch_request)
    except Exception as e:
        print("Exception when calling MessagingApi->rich_menu_batch: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_batch_request	RichMenuBatchRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
202	Accepted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_default_rich_menu

set_default_rich_menu(rich_menu_id)

Set default rich menu

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_id = 'rich_menu_id_example' # str | ID of a rich menu

    try:
        api_instance.set_default_rich_menu(rich_menu_id)
    except Exception as e:
        print("Exception when calling MessagingApi->set_default_rich_menu: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_id	str	ID of a rich menu

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_webhook_endpoint

set_webhook_endpoint(set_webhook_endpoint_request)

Set webhook endpoint URL

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.set_webhook_endpoint_request import SetWebhookEndpointRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    set_webhook_endpoint_request = linebot.v3.messaging.SetWebhookEndpointRequest() # SetWebhookEndpointRequest | 

    try:
        api_instance.set_webhook_endpoint(set_webhook_endpoint_request)
    except Exception as e:
        print("Exception when calling MessagingApi->set_webhook_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
set_webhook_endpoint_request	SetWebhookEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show_loading_animation

object show_loading_animation(show_loading_animation_request)

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.show_loading_animation_request import ShowLoadingAnimationRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    show_loading_animation_request = linebot.v3.messaging.ShowLoadingAnimationRequest() # ShowLoadingAnimationRequest | 

    try:
        api_response = api_instance.show_loading_animation(show_loading_animation_request)
        print("The response of MessagingApi->show_loading_animation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->show_loading_animation: %s\n" % e)

Parameters

Name	Type	Description	Notes
show_loading_animation_request	ShowLoadingAnimationRequest

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	An invalid chat ID is specified, or the loadingSeconds value is invalid.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_webhook_endpoint

TestWebhookEndpointResponse test_webhook_endpoint(test_webhook_endpoint_request=test_webhook_endpoint_request)

Test webhook endpoint

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.test_webhook_endpoint_request import TestWebhookEndpointRequest
from linebot.v3.messaging.models.test_webhook_endpoint_response import TestWebhookEndpointResponse
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    test_webhook_endpoint_request = linebot.v3.messaging.TestWebhookEndpointRequest() # TestWebhookEndpointRequest |  (optional)

    try:
        api_response = api_instance.test_webhook_endpoint(test_webhook_endpoint_request=test_webhook_endpoint_request)
        print("The response of MessagingApi->test_webhook_endpoint:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessagingApi->test_webhook_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_webhook_endpoint_request	TestWebhookEndpointRequest		[optional]

Return type

TestWebhookEndpointResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlink_rich_menu_id_from_user

unlink_rich_menu_id_from_user(user_id)

Unlink rich menu from user

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    user_id = 'user_id_example' # str | User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.

    try:
        api_instance.unlink_rich_menu_id_from_user(user_id)
    except Exception as e:
        print("Exception when calling MessagingApi->unlink_rich_menu_id_from_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlink_rich_menu_id_from_users

unlink_rich_menu_id_from_users(rich_menu_bulk_unlink_request)

Unlink rich menus from multiple users

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_bulk_unlink_request import RichMenuBulkUnlinkRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_bulk_unlink_request = linebot.v3.messaging.RichMenuBulkUnlinkRequest() # RichMenuBulkUnlinkRequest | 

    try:
        api_instance.unlink_rich_menu_id_from_users(rich_menu_bulk_unlink_request)
    except Exception as e:
        print("Exception when calling MessagingApi->unlink_rich_menu_id_from_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_bulk_unlink_request	RichMenuBulkUnlinkRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
202	Accepted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_rich_menu_alias

update_rich_menu_alias(rich_menu_alias_id, update_rich_menu_alias_request)

Update rich menu alias

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.update_rich_menu_alias_request import UpdateRichMenuAliasRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_alias_id = 'rich_menu_alias_id_example' # str | The rich menu alias ID you want to update.
    update_rich_menu_alias_request = linebot.v3.messaging.UpdateRichMenuAliasRequest() # UpdateRichMenuAliasRequest | 

    try:
        api_instance.update_rich_menu_alias(rich_menu_alias_id, update_rich_menu_alias_request)
    except Exception as e:
        print("Exception when calling MessagingApi->update_rich_menu_alias: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_alias_id	str	The rich menu alias ID you want to update.
update_rich_menu_alias_request	UpdateRichMenuAliasRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_broadcast

validate_broadcast(validate_message_request)

Validate message objects of a broadcast message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.validate_message_request import ValidateMessageRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    validate_message_request = linebot.v3.messaging.ValidateMessageRequest() # ValidateMessageRequest | 

    try:
        api_instance.validate_broadcast(validate_message_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_broadcast: %s\n" % e)

Parameters

Name	Type	Description	Notes
validate_message_request	ValidateMessageRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_multicast

validate_multicast(validate_message_request)

Validate message objects of a multicast message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.validate_message_request import ValidateMessageRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    validate_message_request = linebot.v3.messaging.ValidateMessageRequest() # ValidateMessageRequest | 

    try:
        api_instance.validate_multicast(validate_message_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_multicast: %s\n" % e)

Parameters

Name	Type	Description	Notes
validate_message_request	ValidateMessageRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_narrowcast

validate_narrowcast(validate_message_request)

Validate message objects of a narrowcast message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.validate_message_request import ValidateMessageRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    validate_message_request = linebot.v3.messaging.ValidateMessageRequest() # ValidateMessageRequest | 

    try:
        api_instance.validate_narrowcast(validate_message_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_narrowcast: %s\n" % e)

Parameters

Name	Type	Description	Notes
validate_message_request	ValidateMessageRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_push

validate_push(validate_message_request)

Validate message objects of a push message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.validate_message_request import ValidateMessageRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    validate_message_request = linebot.v3.messaging.ValidateMessageRequest() # ValidateMessageRequest | 

    try:
        api_instance.validate_push(validate_message_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_push: %s\n" % e)

Parameters

Name	Type	Description	Notes
validate_message_request	ValidateMessageRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_reply

validate_reply(validate_message_request)

Validate message objects of a reply message

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.validate_message_request import ValidateMessageRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    validate_message_request = linebot.v3.messaging.ValidateMessageRequest() # ValidateMessageRequest | 

    try:
        api_instance.validate_reply(validate_message_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_reply: %s\n" % e)

Parameters

Name	Type	Description	Notes
validate_message_request	ValidateMessageRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_rich_menu_batch_request

validate_rich_menu_batch_request(rich_menu_batch_request)

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_batch_request import RichMenuBatchRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_batch_request = linebot.v3.messaging.RichMenuBatchRequest() # RichMenuBatchRequest | 

    try:
        api_instance.validate_rich_menu_batch_request(rich_menu_batch_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_rich_menu_batch_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_batch_request	RichMenuBatchRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_rich_menu_object

validate_rich_menu_object(rich_menu_request)

Validate rich menu object

Example

Bearer Authentication (Bearer):

import time
import os
import linebot.v3.messaging
from linebot.v3.messaging.models.rich_menu_request import RichMenuRequest
from linebot.v3.messaging.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.line.me
# See configuration.py for a list of all supported configuration parameters.
configuration = linebot.v3.messaging.Configuration(
    host = "https://api.line.me"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = linebot.v3.messaging.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with linebot.v3.messaging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linebot.v3.messaging.MessagingApi(api_client)
    rich_menu_request = linebot.v3.messaging.RichMenuRequest() # RichMenuRequest | 

    try:
        api_instance.validate_rich_menu_object(rich_menu_request)
    except Exception as e:
        print("Exception when calling MessagingApi->validate_rich_menu_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
rich_menu_request	RichMenuRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MessagingApi.md

Latest commit

History

MessagingApi.md

File metadata and controls

linebot.v3.messaging.MessagingApi

broadcast

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancel_default_rich_menu

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_rich_menu

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_rich_menu_alias

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_rich_menu

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_rich_menu_alias

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_aggregation_unit_name_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_aggregation_unit_usage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_bot_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_default_rich_menu_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_followers

Example

Parameters