Method: Line::Bot::V2::MessagingApi::ApiClient#multicast

Defined in:

lib/line/bot/v2/messaging_api/api/messaging_api_client.rb

#multicast(multicast_request:, x_line_retry_key: nil) ⇒ String, ...

An API that efficiently sends the same message to multiple user IDs. You can’t send messages to group chats or multi-person chats. This requests to POST https://api.line.me/v2/bot/message/multicast When you want to get HTTP status code or response headers, use #multicast_with_http_info instead of this.

Parameters:

• multicast_request (MulticastRequest)
• x_line_retry_key (String, nil) (defaults to: nil) —

  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.

Returns:

• (String, nil) —

  when HTTP status code is 200

• (Line::Bot::V2::MessagingApi::ErrorResponse) —

  when HTTP status code is 400

• (Line::Bot::V2::MessagingApi::ErrorResponse) —

  when HTTP status code is 403

• (Line::Bot::V2::MessagingApi::ErrorResponse) —

  when HTTP status code is 409

• (Line::Bot::V2::MessagingApi::ErrorResponse) —

  when HTTP status code is 429

• (String, nil) —

  when other HTTP status code is returned. This String is HTTP response body itself.

See Also:

• https://developers.line.biz/en/reference/messaging-api/#send-multicast-message

# File 'lib/line/bot/v2/messaging_api/api/messaging_api_client.rb', line 2660

def multicast(
  multicast_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = multicast_with_http_info(
    multicast_request: multicast_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end