Get Phone Number Status

Check the status of the individual phone number/campaign assignments associated with the supplied taskId.

GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers

JavaScript

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.listPhoneNumberStatus(
  'taskId',
);

console.log(response.records);

200

{
  "records": [
    {
      "taskId": "667a80f8-b0a9-49d0-b9ab-a7a1bcc45086",
      "phoneNumber": "[phone]",
      "status": "pending"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

taskId · string · required

Query Parameters

recordsPerPage · integer · default: 20

page · integer · default: 1

Response

200

application/json

Successful Response

records · ProfileAssignmentPhoneNumbers · object[] · required

Show child attributes