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

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/messages/rcs.rb

Overview

Send RCS messages

Instance Method Summary collapse

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:



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

def initialize(client:)
  @client = client
end

Instance Method Details

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:

See Also:



24
25
26
27
28
29
30
31
32
33
34
 
# 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

Send an RCS message

Parameters:

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/telnyx/resources/messages/rcs.rb', line 61

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