Get Disposition Group

curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/dispositions/groups/{id} \
  --header 'Authorization: <authorization>'

{
  "success": true,
  "data": {
    "id": "BQhJQMcijOPZEVhXgova",
    "name": "Call Back",
    "description": "Call customer again if given dispositions are found",
    "dispositions": [
      "qmJFQyVugpOAPjREQeEF",
      "sorlyJWVWKvqzfPFFeuT"
    ],
    "dispositionDetails": [
      {
        "id": "qmJFQyVugpOAPjREQeEF",
        "name": "No Answer",
        "description": "Customer did not pick up",
        "priority": 100
      },
      {
        "id": "sorlyJWVWKvqzfPFFeuT",
        "name": "Busy",
        "description": "Line was busy",
        "priority": 110
      }
    ],
    "createdAt": "2024-11-19T12:32:10",
    "updatedAt": "2024-11-19T12:32:10"
  }
}

curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/dispositions/groups/{id} \
  --header 'Authorization: <authorization>'

{
  "success": true,
  "data": {
    "id": "BQhJQMcijOPZEVhXgova",
    "name": "Call Back",
    "description": "Call customer again if given dispositions are found",
    "dispositions": [
      "qmJFQyVugpOAPjREQeEF",
      "sorlyJWVWKvqzfPFFeuT"
    ],
    "dispositionDetails": [
      {
        "id": "qmJFQyVugpOAPjREQeEF",
        "name": "No Answer",
        "description": "Customer did not pick up",
        "priority": 100
      },
      {
        "id": "sorlyJWVWKvqzfPFFeuT",
        "name": "Busy",
        "description": "Line was busy",
        "priority": 110
      }
    ],
    "createdAt": "2024-11-19T12:32:10",
    "updatedAt": "2024-11-19T12:32:10"
  }
}

Overview

Retrieve detailed information about a specific disposition group using its unique ID.

Headers

Authorization

string

required

Bearer token for authentication (e.g., Bearer <your_token>).

Path Parameters

string

required

The unique identifier of the disposition group

Query Parameters

expand

boolean

default:"false"

If true, includes full disposition details

Response

success

boolean

Indicates if the request was successful

data

object

Disposition group object

Show properties

string

Unique group ID

name

string

Group name

description

string

Group description

dispositions

array

Array of disposition IDs

dispositionDetails

array

Full disposition objects (only when expand=true)

createdAt

string

Creation timestamp

updatedAt

string

Last update timestamp

{
  "success": true,
  "data": {
    "id": "BQhJQMcijOPZEVhXgova",
    "name": "Call Back",
    "description": "Call customer again if given dispositions are found",
    "dispositions": [
      "qmJFQyVugpOAPjREQeEF",
      "sorlyJWVWKvqzfPFFeuT"
    ],
    "dispositionDetails": [
      {
        "id": "qmJFQyVugpOAPjREQeEF",
        "name": "No Answer",
        "description": "Customer did not pick up",
        "priority": 100
      },
      {
        "id": "sorlyJWVWKvqzfPFFeuT",
        "name": "Busy",
        "description": "Line was busy",
        "priority": 110
      }
    ],
    "createdAt": "2024-11-19T12:32:10",
    "updatedAt": "2024-11-19T12:32:10"
  }
}

Error Codes

Status	Description
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Missing required permissions
`404`	Disposition group with the specified ID was not found
`500`	Internal server error

Create Disposition Group Update Disposition Group

​Overview

​Headers

​Path Parameters

​Query Parameters

​Response

​Error Codes

Overview

Headers

Path Parameters

Query Parameters

Response

Error Codes