team-telnyx/telnyx-messaging-hosted-ruby

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Messaging Hosted - Ruby

Installation

gem install telnyx

Setup

require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)

All examples below assume client is already initialized as shown above.

List messaging hosted number orders

GET /messaging_hosted_number_orders

page = client.messaging_hosted_number_orders.list

puts(page)

Create a messaging hosted number order

POST /messaging_hosted_number_orders

messaging_hosted_number_order = client.messaging_hosted_number_orders.create

puts(messaging_hosted_number_order)

Retrieve a messaging hosted number order

GET /messaging_hosted_number_orders/{id}

messaging_hosted_number_order = client.messaging_hosted_number_orders.retrieve("id")

puts(messaging_hosted_number_order)

Delete a messaging hosted number order

Delete a messaging hosted number order and all associated phone numbers.

DELETE /messaging_hosted_number_orders/{id}

messaging_hosted_number_order = client.messaging_hosted_number_orders.delete("id")

puts(messaging_hosted_number_order)

Upload hosted number document

POST /messaging_hosted_number_orders/{id}/actions/file_upload

response = client.messaging_hosted_number_orders.actions.upload_file("id")

puts(response)

Validate hosted number codes

Validate the verification codes sent to the numbers of the hosted order.

POST /messaging_hosted_number_orders/{id}/validation_codes — Required: verification_codes

response = client.messaging_hosted_number_orders.validate_codes(
  "id",
  verification_codes: [{code: "code", phone_number: "phone_number"}]
)

puts(response)

Create hosted number verification codes

Create verification codes to validate numbers of the hosted order.

POST /messaging_hosted_number_orders/{id}/verification_codes — Required: phone_numbers, verification_method

response = client.messaging_hosted_number_orders.create_verification_codes(
  "id",
  phone_numbers: ["string"],
  verification_method: :sms
)

puts(response)

Check hosted messaging eligibility

POST /messaging_hosted_number_orders/eligibility_numbers_check — Required: phone_numbers

response = client.messaging_hosted_number_orders.check_eligibility(phone_numbers: ["string"])

puts(response)

Delete a messaging hosted number

DELETE /messaging_hosted_numbers/{id}

messaging_hosted_number = client.messaging_hosted_numbers.delete("id")

puts(messaging_hosted_number)

Send an RCS message

POST /messages/rcs — Required: agent_id, to, messaging_profile_id, agent_message

response = client.messages.rcs.send_(
  agent_id: "Agent007",
  agent_message: {},
  messaging_profile_id: "messaging_profile_id",
  to: "+13125551234"
)

puts(response)

List all RCS agents

GET /messaging/rcs/agents

page = client.messaging.rcs.agents.list

puts(page)

Retrieve an RCS agent

GET /messaging/rcs/agents/{id}

rcs_agent_response = client.messaging.rcs.agents.retrieve("id")

puts(rcs_agent_response)

Modify an RCS agent

PATCH /messaging/rcs/agents/{id}

rcs_agent_response = client.messaging.rcs.agents.update("id")

puts(rcs_agent_response)

Check RCS capabilities (batch)

POST /messaging/rcs/bulk_capabilities — Required: agent_id, phone_numbers

response = client.messaging.rcs.list_bulk_capabilities(agent_id: "TestAgent", phone_numbers: ["+13125551234"])

puts(response)

Check RCS capabilities

GET /messaging/rcs/capabilities/{agent_id}/{phone_number}

response = client.messaging.rcs.retrieve_capabilities("phone_number", agent_id: "agent_id")

puts(response)

Add RCS test number

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

PUT /messaging/rcs/test_number_invite/{id}/{phone_number}

response = client.messaging.rcs.invite_test_number("phone_number", id: "id")

puts(response)

Generate RCS deeplink

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

GET /messages/rcs_deeplinks/{agent_id}

response = client.messages.rcs.generate_deeplink("agent_id")

puts(response)

List Verification Requests

Get a list of previously-submitted tollfree verification requests

GET /messaging_tollfree/verification/requests

page = client.messaging_tollfree.verification.requests.list(page: 1, page_size: 1)

puts(page)

Submit Verification Request

Submit a new tollfree verification request

POST /messaging_tollfree/verification/requests — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation, isvReseller

verification_request_egress = client.messaging_tollfree.verification.requests.create(
  additional_information: "additionalInformation",
  business_addr1: "600 Congress Avenue",
  business_city: "Austin",
  business_contact_email: "[email protected]",
  business_contact_first_name: "John",
  business_contact_last_name: "Doe",
  business_contact_phone: "+18005550100",
  business_name: "Telnyx LLC",
  business_state: "Texas",
  business_zip: "78701",
  corporate_website: "http://example.com",
  isv_reseller: "isvReseller",
  message_volume: :"100,000",
  opt_in_workflow: "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
  opt_in_workflow_image_urls: [{url: "https://client.com/sign-up"}, {url: "https://client.com/company/data-privacy"}],
  phone_numbers: [{phoneNumber: "+18773554398"}, {phoneNumber: "+18773554399"}],
  production_message_content: "Your Telnyx OTP is XXXX",
  use_case: :"2FA",
  use_case_summary: "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal"
)

puts(verification_request_egress)

Get Verification Request

Get a single verification request by its ID.

GET /messaging_tollfree/verification/requests/{id}

verification_request_status = client.messaging_tollfree.verification.requests.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(verification_request_status)

Update Verification Request

Update an existing tollfree verification request.

PATCH /messaging_tollfree/verification/requests/{id} — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation, isvReseller

verification_request_egress = client.messaging_tollfree.verification.requests.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  additional_information: "additionalInformation",
  business_addr1: "600 Congress Avenue",
  business_city: "Austin",
  business_contact_email: "[email protected]",
  business_contact_first_name: "John",
  business_contact_last_name: "Doe",
  business_contact_phone: "+18005550100",
  business_name: "Telnyx LLC",
  business_state: "Texas",
  business_zip: "78701",
  corporate_website: "http://example.com",
  isv_reseller: "isvReseller",
  message_volume: :"100,000",
  opt_in_workflow: "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
  opt_in_workflow_image_urls: [{url: "https://client.com/sign-up"}, {url: "https://client.com/company/data-privacy"}],
  phone_numbers: [{phoneNumber: "+18773554398"}, {phoneNumber: "+18773554399"}],
  production_message_content: "Your Telnyx OTP is XXXX",
  use_case: :"2FA",
  use_case_summary: "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal"
)

puts(verification_request_egress)

Delete Verification Request

Delete a verification request

A request may only be deleted when when the request is in the "rejected" state.

DELETE /messaging_tollfree/verification/requests/{id}

result = client.messaging_tollfree.verification.requests.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)