Class: Telnyx::Resources::Messaging::Rcs

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/messaging/rcs.rb,
lib/telnyx/resources/messaging/rcs/agents.rb

Overview

Send RCS messages

Defined Under Namespace

Classes: Agents

Instance Attribute Summary collapse

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:



93
94
95
96
 
# File 'lib/telnyx/resources/messaging/rcs.rb', line 93

def initialize(client:)
  @client = client
  @agents = Telnyx::Resources::Messaging::Rcs::Agents.new(client: client)
end

Instance Attribute Details

#agents ⇒ Telnyx::Resources::Messaging::Rcs::Agents (readonly)

Send RCS messages

Returns:



10
11
12
 
# File 'lib/telnyx/resources/messaging/rcs.rb', line 10

def agents
  @agents
end

Instance Method Details

#invite_test_number(phone_number, id:, request_options: {}) ⇒ Telnyx::Models::Messaging::RcInviteTestNumberResponse

Adds a test phone number to an RCS agent for testing purposes.

Parameters:

  • phone_number (String) —

    Phone number in E164 format to invite for testing

  • id (String) —

    RCS agent ID

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/telnyx/resources/messaging/rcs.rb', line 25

def invite_test_number(phone_number, params)
  parsed, options = Telnyx::Messaging::RcInviteTestNumberParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["messaging/rcs/test_number_invite/%1$s/%2$s", id, phone_number],
    model: Telnyx::Models::Messaging::RcInviteTestNumberResponse,
    options: options
  )
end

#list_bulk_capabilities(agent_id:, phone_numbers:, request_options: {}) ⇒ Telnyx::Models::Messaging::RcListBulkCapabilitiesResponse

Check RCS capabilities (batch)

Parameters:

  • agent_id (String) —

    RCS Agent ID

  • phone_numbers (Array<String>) —

    List of phone numbers to check

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

Returns:

See Also:



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/telnyx/resources/messaging/rcs.rb', line 52

def list_bulk_capabilities(params)
  parsed, options = Telnyx::Messaging::RcListBulkCapabilitiesParams.dump_request(params)
  @client.request(
    method: :post,
    path: "messaging/rcs/bulk_capabilities",
    body: parsed,
    model: Telnyx::Models::Messaging::RcListBulkCapabilitiesResponse,
    options: options
  )
end

#retrieve_capabilities(phone_number, agent_id:, request_options: {}) ⇒ Telnyx::Models::Messaging::RcRetrieveCapabilitiesResponse

Check RCS capabilities

Parameters:

  • phone_number (String) —

    Phone number in E164 format

  • agent_id (String) —

    RCS agent ID

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

Returns:

See Also:



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/telnyx/resources/messaging/rcs.rb', line 76

def retrieve_capabilities(phone_number, params)
  parsed, options = Telnyx::Messaging::RcRetrieveCapabilitiesParams.dump_request(params)
  agent_id =
    parsed.delete(:agent_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["messaging/rcs/capabilities/%1$s/%2$s", agent_id, phone_number],
    model: Telnyx::Models::Messaging::RcRetrieveCapabilitiesResponse,
    options: options
  )
end