Class: Telnyx::Resources::Messages::Rcs

Inherits:

Object

• Object
• Telnyx::Resources::Messages::Rcs

Defined in:

lib/telnyx/resources/messages/rcs.rb,
sig/telnyx/resources/messages/rcs.rbs

Overview

Send RCS messages

Instance Method Summary

• #generate_deeplink(agent_id, body: nil, phone_number: nil, request_options: {}) ⇒ Telnyx::Models::Messages::RcGenerateDeeplinkResponse

  Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.

• #initialize(client:) ⇒ Rcs constructor private

  A new instance of Rcs.

• #send_(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::Messages::RcSendResponse

  Queues an outbound RCS message through the selected RCS agent.

Constructor Details

#initialize(client:) ⇒ Rcs

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Rcs.

Parameters:

• client (Telnyx::Client)
• client: (Telnyx::Client)

# File 'lib/telnyx/resources/messages/rcs.rb', line 76

def initialize(client:)
  @client = client
end

Instance Method Details

#generate_deeplink(agent_id, body: nil, phone_number: nil, request_options: {}) ⇒ Telnyx::Models::Messages::RcGenerateDeeplinkResponse

Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.

Parameters:

• agent_id (String) —

  RCS agent ID

• body (String) —

  Pre-filled message body (URL encoded)

• phone_number (String) —

  Phone number in E164 format (URL encoded)

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Messages::RcGenerateDeeplinkResponse)

See Also:

• Models::Messages::RcGenerateDeeplinkParams

# File 'lib/telnyx/resources/messages/rcs.rb', line 24

def generate_deeplink(agent_id, params = {})
  parsed, options = Telnyx::Messages::RcGenerateDeeplinkParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["messages/rcs/deeplinks/%1$s", agent_id],
    query: query,
    model: Telnyx::Models::Messages::RcGenerateDeeplinkResponse,
    options: options
  )
end

#send_(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::Messages::RcSendResponse

Queues an outbound RCS message through the selected RCS agent. Check recipient capabilities before sending features that require RCS support.

Parameters:

• agent_id (String) —

  RCS Agent ID

• agent_message (Telnyx::Models::RcsAgentMessage)
• messaging_profile_id (String) —

  A valid messaging profile ID

• to (String) —

  Phone number in +E.164 format

• mms_fallback (Telnyx::Models::Messages::RcSendParams::MmsFallback)
• sms_fallback (Telnyx::Models::Messages::RcSendParams::SMSFallback)
• type (Symbol, Telnyx::Models::Messages::RcSendParams::Type) —

  Message type - must be set to "RCS"

• webhook_url (String) —

  The URL where webhooks related to this message will be sent.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Messages::RcSendResponse)

See Also:

• Models::Messages::RcSendParams

# File 'lib/telnyx/resources/messages/rcs.rb', line 62

def send_(params)
  parsed, options = Telnyx::Messages::RcSendParams.dump_request(params)
  @client.request(
    method: :post,
    path: "messages/rcs",
    body: parsed,
    model: Telnyx::Models::Messages::RcSendResponse,
    options: options
  )
end