Get Assignment Task Status

GET 
/phoneNumberAssignmentByProfile/:taskId

Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by taskId.

Request

Path Parameters

taskId Taskidrequired

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

taskId Taskid (string)required
status TaskStatus (string)required

Possible values: [pending, processing, completed, failed]

An enumeration.

createdAt date-time
updatedAt date-time

{
  "taskId": "string",
  "status": "pending",
  "createdAt": "2024-07-26T07:42:15.414Z",
  "updatedAt": "2024-07-26T07:42:15.414Z"
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/10dlc/phoneNumberAssignmentByProfile/:taskId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "taskId": "string",
  "status": "pending",
  "createdAt": "2024-07-26T07:46:18.498Z",
  "updatedAt": "2024-07-26T07:46:18.498Z"
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}