Verify CSR phone number coverage

POST 
/customer_service_records/phone_number_coverages

Verify the coverage for a list of phone numbers.

Request

application/json

Body

required

phone_numbers string[]required

Possible values: Value must match regular expression ^\+1\d{10}$

The phone numbers list to be verified.

Responses

201: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

phone_number string

The phone number that is being verified.

has_csr_coverage boolean

Indicates whether the phone number is covered or not.

reason string

The reason why the phone number is not covered. Only returned if has_csr_coverage is false.

additional_data_required string[]

Possible values: [name, authorized_person_name, account_number, customer_code, pin, address_line_1, city, state, zip_code, billing_phone_number]

Additional data required to perform CSR for the phone number. Only returned if has_csr_coverage is true.

record_type string

Identifies the type of the resource.

]

{
  "data": [
    {
      "phone_number": "+12223334444",
      "has_csr_coverage": true,
      "reason": "The phone number '+19999999999' is invalid.",
      "additional_data_required": [
        "name"
      ],
      "record_type": "customer_service_record_phone_number_coverage"
    }
  ]
}

401: The required authentication headers were either invalid or not included in the request.

application/json

• Schema
• Example (from schema)

Schema

errors object[]

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "The required authentication headers were either invalid or not included in the request.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

403: You do not have permission to perform the requested action on the specified resource or resources.

application/json

• Schema
• Example (from schema)

Schema

errors object[]

{
  "errors": [
    {
      "code": "10010",
      "title": "Authorization failed",
      "detail": "You do not have permission to perform the requested action on the specified resource or resources.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      }
    }
  ]
}

422: Unprocessable entity. Check the 'detail' field in response for details.

application/json

• Schema
• Example (from schema)

Schema

errors object[]

{
  "errors": [
    {
      "code": "10002",
      "title": "Invalid phone number",
      "detail": "The phone number is invalid.",
      "source": {
        "pointer": "/phone_numbers",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10002"
      }
    }
  ]
}

500: An unexpected error occurred.

application/json

• Schema
• Example (from schema)

Schema

errors object[]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occurred.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10007"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://apidev.telnyx.com/v2/customer_service_records/phone_number_coverages' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone_numbers": [
    "+1234567890"
  ]
}'

Response samples

• 201
• 401
• 403
• 422
• 500

---

{
  "data": [
    {
      "phone_number": "+12223334444",
      "has_csr_coverage": true,
      "reason": "The phone number '+19999999999' is invalid.",
      "additional_data_required": [
        "name"
      ],
      "record_type": "customer_service_record_phone_number_coverage"
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "The required authentication headers were either invalid or not included in the request.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10010",
      "title": "Authorization failed",
      "detail": "You do not have permission to perform the requested action on the specified resource or resources.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10002",
      "title": "Invalid phone number",
      "detail": "The phone number is invalid.",
      "source": {
        "pointer": "/phone_numbers",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10002"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occurred.",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10007"
      }
    }
  ]
}