Numbers

Reps' direct lines: numbers that ring one rep first, then the agent#

GET /v1/account/direct-lines

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token). Bearer token: Authorization: Bearer <token> (An API token (ans_pat_ or ans_svc_). Only routes that list a scope here accept one, and only with that scope.).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/direct-lines" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The account's phone numbers with their group and what they run#

GET /v1/account/numbers

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/numbers" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Local numbers you can buy, by area code (owner of a self-serve account with a card)#

GET /v1/account/numbers/available

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Query parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/numbers/available?areaCode=string" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Buy a number and place it in a community (owner of a self-serve account with a card, within the plan’s limit)#

POST /v1/account/numbers/buy

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/numbers/buy" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "e164": "string",
  "groupId": "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Whether the owner can buy a number now, and how many the plan allows#

GET /v1/account/numbers/self-serve

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/numbers/self-serve" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Rename a number (the label your team sees next to it), or say whether the test number rings your team on test calls#

PATCH /v1/account/numbers/{numberId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "string",
  "testRingsTeam": true
}'

Point a number at a playbook: pinned to a version or following the latest publish. Its schedule, if it has one, is kept#

PUT /v1/account/numbers/{numberId}/assignment

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/assignment" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "playbookId": "pb_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
  "mode": "pinned"
}'

What this number ran and when, newest first#

GET /v1/account/numbers/{numberId}/assignments

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/assignments" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Make a number a rep's direct line: every part of its schedule rings them first, then its playbook#

PUT /v1/account/numbers/{numberId}/direct-line

Makes (or reuses) a ring group of that one rep in the number's location and saves the number's plan again with the ring step on every part. The playbooks and the schedule stay as they were; any experiment on the number stops.

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/direct-line" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "usr_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Stop a number being a rep’s direct line: the agent answers it straight away again#

DELETE /v1/account/numbers/{numberId}/direct-line

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 204

No content.

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/direct-line" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Place a number in one of your groups, move it to another, or leave it unplaced#

PUT /v1/account/numbers/{numberId}/group

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/group" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupId": "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Save a number's whole schedule: what it runs at all other times, and each holiday, closure or weekly window that runs another playbook#

PUT /v1/account/numbers/{numberId}/routing

Holidays and closures are checked first, then the weekly schedule, each in the order given; the first that matches answers, in the group's time zone. Saving closes the number's assignment and opens a new one, so any experiment running on the number stops.

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/routing" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "default": {
    "playbookId": "pb_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
    "mode": "pinned"
  },
  "routes": [
    {
      "name": "string",
      "when": {
        "kind": "weekly",
        "windows": [
          {}
        ]
      },
      "playbookId": "pb_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
      "mode": "pinned"
    }
  ]
}'

What a call to this number would do at a moment: which part of the schedule answers, who would ring and when, and who would be skipped and why#

GET /v1/account/numbers/{numberId}/routing/preview

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token). Bearer token: Authorization: Bearer <token> (An API token (ans_pat_ or ans_svc_). Only routes that list a scope here accept one, and only with that scope.).

Path parameters

Query parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/numbers/{numberId}/routing/preview" \
  -H "Authorization: Bearer $ACCESS_TOKEN"