Ring Groups

A location's ring groups: who its numbers can ring before the agent answers#

GET /v1/account/groups/{groupId}/ring-groups

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/groups/{groupId}/ring-groups" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Add a ring group to a location#

POST /v1/account/groups/{groupId}/ring-groups

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

Path parameters

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/groups/{groupId}/ring-groups" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "members": [
    {
      "label": "string",
      "phone": "string",
      "userId": "usr_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
    }
  ]
}'

A ring group with its members and the numbers that ring it#

GET /v1/account/ring-groups/{ringGroupId}

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

Response 200

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

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/ring-groups/{ringGroupId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Save a ring group whole: its settings and its members in ring order. Every number that rings it uses the change on its next call#

PUT /v1/account/ring-groups/{ringGroupId}

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/ring-groups/{ringGroupId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "members": [
    {
      "label": "string",
      "phone": "string",
      "userId": "usr_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
    }
  ]
}'

Archive a ring group no number rings any more#

POST /v1/account/ring-groups/{ringGroupId}/archive

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 POST "$ANSWERSTACK_API_URL/v1/account/ring-groups/{ringGroupId}/archive" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Every saved state of a ring group, newest first: who was in it, in what order, and how it rang#

GET /v1/account/ring-groups/{ringGroupId}/history

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

Response 200

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

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/ring-groups/{ringGroupId}/history" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Bring an archived ring group back#

POST /v1/account/ring-groups/{ringGroupId}/restore

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 POST "$ANSWERSTACK_API_URL/v1/account/ring-groups/{ringGroupId}/restore" \
  -H "Authorization: Bearer $ACCESS_TOKEN"