Sign in
Bulk Phone Number Operations

Lists the phone numbers jobs

Returns background jobs that operate on phone numbers. Filter by job type, target phone numbers, or job status, and sort by creation time. Multiple phone-number or status values use OR semantics within that filter; different filter categories use AND semantics. Results include pagination metadata.

get/phone_numbers/jobs

Query parameters

sizeinteger

The size of the page

numberinteger

The page number to load

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

sort'created_at'
Example:created_at

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

type'update_emergency_settings' | 'delete_phone_numbers' | 'update_phone_numbers'

Identifies the type of the background job.

statusstring[]

Returns jobs with any of the supplied statuses. Use repeated filter[status][] parameters; scalar and comma-separated status values are not accepted.

Consolidated filter parameter (deepObject style). Originally: filter[type], filter[phone_number], filter[phone_number][], filter[status][]

{
  "type": "update_emergency_settings",
  "phone_number": "+15551234567,1234567890123456789",
  "status": [
    "pending",
    "in_progress"
  ]
}

Response

Successful response with a list of phone numbers background jobs.

Example response

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "phone_numbers_job",
      "status": "pending",
      "type": "update_emergency_settings",
      "etc": "2020-10-30T18:10:00.000Z",
      "created_at": "2020-10-23T18:10:00.000Z",
      "updated_at": "2020-10-23T18:10:01.000Z",
      "phone_numbers": [
        {
          "id": "2637816387126861836"
        },
        {
          "phone_number": "+19715555098"
        },
        {
          "phone_number": "+19705555099"
        },
        {
          "id": "3388768018273"
        }
      ],
      "successful_operations": [
        {
          "id": "2637816387126861836",
          "phone_number": "+19705555098"
        },
        {
          "id": "33081887126861836",
          "phone_number": "+19715555098"
        }
      ],
      "pending_operations": [
        {
          "id": "2637816387126861837",
          "phone_number": "+19705555099"
        }
      ],
      "failed_operations": [
        {
          "id": "3388768018273",
          "phone_number": "+19705551234",
          "errors": [
            {
              "code": "10015",
              "title": "Bad Request",
              "detail": "The field is invalid.",
              "source": {
                "pointer": "/emergency_address_id"
              }
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes