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.
Query parameters
Consolidated page parameter (deepObject style). Originally: page[size], page[number]
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
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
Changed in 3 of the 99 revisions of this API.20820
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the response property
//became optional for the statusresponse-property-became-optional
- ▲
the
//response's property type changed fromintegertostring, and format fromint32to no format for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromintegertostring, and format fromint32to no format for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromintegertostring, and format fromint32to no format for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromintegertostring, and format fromint32to no format for statusresponse-property-type-changed
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
Of the 99 revisions, 1 has no diff computed.