Create a customer service record

POST 
/customer_service_records

Create a new customer service record for the provided phone number.

Request

application/json

Body

required

phone_number stringrequired

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

A valid US phone number in E164 format.

webhook_url string

Callback URL to receive webhook notifications.

additional_data

object

name string

The name of the administrator of CSR.

authorized_person_name string

The name of the authorized person.

pin string

The PIN of the customer service record.

account_number string

The account number of the customer service record.

customer_code string

The customer code of the customer service record.

address_line_1 string

The first line of the address of the customer service record.

city string

The city of the customer service record.

state string

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

The state of the customer service record.

zip_code string

Possible values: <= 5 characters, Value must match regular expression ^\d{5}$

The zip code of the customer service record.

billing_phone_number string

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

The billing phone number of the customer service record.

Responses

201: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Uniquely identifies this customer service record

phone_number string

The phone number of the customer service record.

status string

Possible values: [pending, completed, failed]

The status of the customer service record

error_message string

The error message in case status is failed. This field would be null in case of pending or completed status.

result

object

The result of the CSR request. This field would be null in case of pending or failed status.

carrier_name string

The name of the carrier that the customer service record is for.

associated_phone_numbers string[]

The associated phone numbers of the customer service record.

admin

object

The admin of the customer service record.

name string

The name of the customer service record.

billing_phone_number string

The billing phone number of the customer service record.

account_number string

The account number of the customer service record.

authorized_person_name string

The authorized person name of the customer service record.

The admin of the customer service record.

address

object

The address of the customer service record

administrative_area string

The state of the address

locality string

The city of the address

postal_code string

The zip code of the address

street_address string

The street address

full_address string

The full address

The address of the customer service record

record_type string

Identifies the type of the resource.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was created.

{
  "data": {
    "id": "db7cebdb-21a8-4e89-8f51-e03ba6b799bb",
    "phone_number": "+2003271000",
    "status": "pending",
    "error_message": null,
    "result": null,
    "webhook_url": "https://example.com/webhook",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  }
}

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"
      }
    }
  ]
}

Callbacks

Request samples

• cURL

---

curl -L 'https://apidev.telnyx.com/v2/customer_service_records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone_number": "+1234567890",
  "webhook_url": "https://example.com/webhook",
  "additional_data": {
    "name": "Entity Inc.",
    "authorized_person_name": "John Doe",
    "pin": "1234",
    "account_number": "123456789",
    "customer_code": "123456789",
    "address_line_1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip_code": "10001",
    "billing_phone_number": "+12065551212"
  }
}'

Response samples

• 201
• 401
• 403
• 422
• 500

---

{
  "data": {
    "id": "db7cebdb-21a8-4e89-8f51-e03ba6b799bb",
    "phone_number": "+2003271000",
    "status": "pending",
    "error_message": null,
    "result": null,
    "webhook_url": "https://example.com/webhook",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  }
}

{
  "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"
      }
    }
  ]
}