Skip to main content

Get phone number status

GET 

/business/{businessId}/phone

Provides job name and registration status for phone numbers under a single business. Request supports either a list of phone numbers to be checked, or a single job name to check all phone numbers with that job name. It is not supported to provide both a list of phone numbers and a job name in the same request.

This API will paginate the response. The first page is page 0. The response will indicate how many pages of responses are available to be requested. The service provides 100 phone numbers per page.

Path Parameters


    businessId stringrequired

    Id of a business

    Example: 60ff7262-d373-4242-8fc8-a3ecfb51d0c1

Query Parameters


    page int32

    Which page of results should be provided. When calling this API for the first time for a set of numbers, request page 0. Defaults to 0.


    phones string[]

    jobName string

    Optionally a single job name to request all phone numbers with that job name.

Responses

OK

Response Body

application/json