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

Defined in:

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

#push_message(push_message_request:, x_line_retry_key: nil) ⇒ Line::Bot::V2::MessagingApi::PushMessageResponse, ...

Sends a message to a user, group chat, or multi-person chat at any time. This requests to POST https://api.line.me/v2/bot/message/push When you want to get HTTP status code or response headers, use #push_message_with_http_info instead of this.

Parameters:

• push_message_request (PushMessageRequest)
• 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:

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

  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-push-message

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

def push_message(
  push_message_request:,
  x_line_retry_key: nil
)
  response_body, _status_code, _headers = push_message_with_http_info(
    push_message_request: push_message_request,
    x_line_retry_key: x_line_retry_key
  )

  response_body
end