Get Phone Number Status

GET 
/phoneNumberAssignmentByProfile/:taskId/phoneNumbers

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

Request

Path Parameters

taskId Taskidrequired

Query Parameters

recordsPerPage any
page any

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

records

object[]

required

Array [

taskId Taskid (string)required

The ID of the task associated with the phone number.

phoneNumber Phonenumber (string)required

The phone number that the status is being checked for.

status Status (string)required

The status of the associated phone number assignment.

]

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

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"
      }
    }
  ]
}

Loading...