Telnyx

PUT

messaging

rcs

test_number_invite

{id}

{phone_number}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.messaging.rcs.inviteTestNumber('phone_number', { id: 'id' });

console.log(response.data);

{
  "data": {
    "record_type": "rcs.test_number_invite",
    "agent_id": "TestAgent",
    "phone_number": "+13125551234",
    "status": "PENDING"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

RCS agent ID

phone_number

string

required

Phone number in E164 format to invite for testing

Response

Test number successfully invited to RCS agent

data

object

required

Show child attributes

Check RCS capabilities

Generate RCS deeplink

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.messaging.rcs.inviteTestNumber('phone_number', { id: 'id' });

console.log(response.data);

{
  "data": {
    "record_type": "rcs.test_number_invite",
    "agent_id": "TestAgent",
    "phone_number": "+13125551234",
    "status": "PENDING"
  }
}