Bulk Phone Number Operations

Lists the phone numbers jobs

Returns background jobs that operate on phone numbers. Results can be filtered by job type and sorted by creation time, and include pagination metadata.

get/phone_numbers/jobs

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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.

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

{
  "type": "update_emergency_settings"
}

Response

Successful response with a list of phone numbers background jobs.

Example response

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