Telnyx

GET

10dlc

phoneNumberAssignmentByProfile

{taskId}

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.messaging10dlc.phoneNumberAssignmentByProfile.retrieveStatus(
  'taskId',
);

console.log(response.status);

{
  "taskId": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

taskId

string

required

Response

Successful Response

taskId

string

required

status

enum<string>

required

The status of the task associated with assigning a messaging profile to a campaign.

Available options:

pending,

processing,

completed,

failed

Example:

"pending"

createdAt

string<date-time>

updatedAt

string<date-time>

Assign Messaging Profile To Campaign

Get Phone Number Status

⌘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.messaging10dlc.phoneNumberAssignmentByProfile.retrieveStatus(
  'taskId',
);

console.log(response.status);

{
  "taskId": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}