Agent Management

List Agents

GET/workspaces/{workspaceId}/agents

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Agent (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "statusBeforeOffline": "active",
      "name": "text",
      "overrideName": false,
      "workspaceId": "text",
      "type": "user",
      "userEmails": [
        "text"
      ],
      "bio": "text",
      "avatarUrl": "text",
      "dropVms": [
        {
          "name": "text",
          "playback": {
            "media": [
              "text"
            ],
            "pauseMilliseconds": 0
          },
          "say": {
            "text": "text",
            "voice": "text",
            "locale": "en-US"
          }
        }
      ],
      "tagCount": 0,
      "wrapUpTime": 0,
      "lastAssignedAt": "2024-12-22T01:44:41.288Z",
      "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2024-12-22T01:44:41.288Z",
          "activeMemberCount": 0,
          "pendingMemberCount": 0
        }
      ],
      "workload": {
        "id": "text",
        "workload": {
          "messaging": 0,
          "email": 0
        },
        "rule": {
          "id": "text",
          "workspaceId": "text",
          "name": "text",
          "description": "text",
          "default": false,
          "capacity": {
            "messaging": 0,
            "email": 0
          },
          "assignedAgentIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "createdAt": "text",
          "updatedAt": "text"
        },
        "ruleId": "text",
        "updatedAt": "2024-12-22T01:44:41.288Z"
      },
      "createdAt": "2024-12-22T01:44:41.288Z",
      "updatedAt": "2024-12-22T01:44:41.288Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 0,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2024-12-22T01:44:41.288Z"
      },
      "timezone": "text",
      "defaultCountryCode": "text",
      "defaultCallerId": "text",
      "forwardNumber": {
        "enabled": false,
        "number": "text",
        "maskCaller": false
      },
      "transcriptionLocale": "ar-AE",
      "roles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "avatarUrl": "text",
        "defaultEmail": "text",
        "phoneNumber": "text"
      },
      "weeklySchedule": {
        "monday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "tuesday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "wednesday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "thursday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "friday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "saturday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        },
        "sunday": {
          "from": {
            "hour": 0,
            "minute": 0
          },
          "to": {
            "hour": 0,
            "minute": 0
          }
        }
      },
      "holidays": [
        {
          "name": "text",
          "day": 0,
          "month": 0
        }
      ],
      "assignedSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "valueType": "single",
          "selectedValues": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text",
              "icon": "text"
            }
          ]
        }
      ],
      "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
      "outOfOfficeResponse": "text"
    }
  ],
  "nextPageToken": "text",
  "total": 0
}

Create Agent

Create a new agent with specified details like name, role, and basic bio.

POST/workspaces/{workspaceId}/agents

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

CreateAgent (one of)

CreateAgentByUserId (object)CreateAgentByEmail (object)

Response

201404409422

Created

Body

application/json

id*string

statusAgentStatus (enum)

activeawayout-of-office

statusBeforeOfflineAgentStatus (enum)

activeawayout-of-office

namestring

overrideNameboolean

workspaceId*string

typeenum

user

userEmailsarray of string

biostring

avatarUrlstring

dropVmsarray of object

tagCountinteger

wrapUpTimeinteger

lastAssignedAtstring (date-time)

lastSetToAwayAtstring (date-time)

teamsarray of object

workloadAgentWorkload (object)

createdAt*string (date-time)

updatedAt*string (date-time)

availabilityAgentAvailability (object)

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

rolesarray of RoleReference

usernullable object

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedSkillsnullable array of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "user",
      "userId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

201404409422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": false,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    {
      "name": "text",
      "playback": {
        "media": [
          "text"
        ],
        "pauseMilliseconds": 0
      },
      "say": {
        "text": "text",
        "voice": "text",
        "locale": "en-US"
      }
    }
  ],
  "tagCount": 0,
  "wrapUpTime": 0,
  "lastAssignedAt": "2024-12-22T01:44:41.288Z",
  "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2024-12-22T01:44:41.288Z",
      "activeMemberCount": 0,
      "pendingMemberCount": 0
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 0,
      "email": 0
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": false,
      "capacity": {
        "messaging": 0,
        "email": 0
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "createdAt": "2024-12-22T01:44:41.288Z",
  "updatedAt": "2024-12-22T01:44:41.288Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 0,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": false,
    "number": "text",
    "maskCaller": false
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "tuesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "wednesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "thursday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "friday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "saturday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "sunday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 0,
      "month": 0
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

List All Agents

Lists all agents for a workspace returning only minimal fields for each agent.

GET/workspaces/{workspaceId}/all-agents

Authorization

useraccessKey

Path parameters

workspaceId*string

Response

200

OK

Body

application/json

results*array of AgentSummary (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/all-agents', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "name": "text",
      "avatarUrl": "text",
      "createdAt": "2024-12-22T01:44:41.288Z"
    }
  ]
}

Get Agent

Retrieve information about a specific agent, including their name, bio, status.

GET/workspaces/{workspaceId}/agents/{agentId}

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

200404

OK

Body

application/json

id*string

statusAgentStatus (enum)

activeawayout-of-office

statusBeforeOfflineAgentStatus (enum)

activeawayout-of-office

namestring

overrideNameboolean

workspaceId*string

typeenum

user

userEmailsarray of string

biostring

avatarUrlstring

dropVmsarray of object

tagCountinteger

wrapUpTimeinteger

lastAssignedAtstring (date-time)

lastSetToAwayAtstring (date-time)

teamsarray of object

workloadAgentWorkload (object)

createdAt*string (date-time)

updatedAt*string (date-time)

availabilityAgentAvailability (object)

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

rolesarray of RoleReference

usernullable object

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedSkillsnullable array of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": false,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    {
      "name": "text",
      "playback": {
        "media": [
          "text"
        ],
        "pauseMilliseconds": 0
      },
      "say": {
        "text": "text",
        "voice": "text",
        "locale": "en-US"
      }
    }
  ],
  "tagCount": 0,
  "wrapUpTime": 0,
  "lastAssignedAt": "2024-12-22T01:44:41.288Z",
  "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2024-12-22T01:44:41.288Z",
      "activeMemberCount": 0,
      "pendingMemberCount": 0
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 0,
      "email": 0
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": false,
      "capacity": {
        "messaging": 0,
        "email": 0
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "createdAt": "2024-12-22T01:44:41.288Z",
  "updatedAt": "2024-12-22T01:44:41.288Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 0,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": false,
    "number": "text",
    "maskCaller": false
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "tuesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "wednesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "thursday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "friday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "saturday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "sunday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 0,
      "month": 0
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get url to upload profile avatar to

Retrieve the url and form data to post profile avatar directly.

GET/workspaces/{workspaceId}/agents/{agentId}/presigned-upload

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

200

OK

Body

application/json

mediaUrlstring

URL to download the media from

fileIdstring (uuid)

File ID

url*string

URL to post the image to

formData*object

expectedFieldsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/presigned-upload', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get url to upload audio files

Retrieve the url and form data to post audio files directly.

POST/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

200

OK

Body

application/json

mediaUrlstring

URL to download the media from

fileIdstring (uuid)

File ID

url*string

URL to post the image to

formData*object

expectedFieldsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get agent media download

Get media download from an agent

GET/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

fileId*string

Query parameters

Response

200302400404

Return file location

Headers

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

400404

{
  "code": "text",
  "message": "text"
}

Update Agent

Modify the details of a specific agent, such as their name, bio, status.

PATCH/workspaces/{workspaceId}/agents/{agentId}

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Body

application/json

nameproperties-name (string)

biobio (string)

statusAgentStatus (enum)

activeawayout-of-office

avatarUrlproperties-avatarUrl (string)

dropVmsdropVms (array of object)

wrapUpTimeinteger

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

weeklyScheduleWeeklySchedule (object)

holidaysarray of Holiday (object)

assignedSkillsarray of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Response

200404422

Updated

Body

application/json

id*string

statusAgentStatus (enum)

activeawayout-of-office

statusBeforeOfflineAgentStatus (enum)

activeawayout-of-office

namestring

overrideNameboolean

workspaceId*string

typeenum

user

userEmailsarray of string

biostring

avatarUrlstring

dropVmsarray of object

tagCountinteger

wrapUpTimeinteger

lastAssignedAtstring (date-time)

lastSetToAwayAtstring (date-time)

teamsarray of object

workloadAgentWorkload (object)

createdAt*string (date-time)

updatedAt*string (date-time)

availabilityAgentAvailability (object)

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

rolesarray of RoleReference

usernullable object

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedSkillsnullable array of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": false,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    {
      "name": "text",
      "playback": {
        "media": [
          "text"
        ],
        "pauseMilliseconds": 0
      },
      "say": {
        "text": "text",
        "voice": "text",
        "locale": "en-US"
      }
    }
  ],
  "tagCount": 0,
  "wrapUpTime": 0,
  "lastAssignedAt": "2024-12-22T01:44:41.288Z",
  "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2024-12-22T01:44:41.288Z",
      "activeMemberCount": 0,
      "pendingMemberCount": 0
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 0,
      "email": 0
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": false,
      "capacity": {
        "messaging": 0,
        "email": 0
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "createdAt": "2024-12-22T01:44:41.288Z",
  "updatedAt": "2024-12-22T01:44:41.288Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 0,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": false,
    "number": "text",
    "maskCaller": false
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "tuesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "wednesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "thursday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "friday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "saturday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "sunday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 0,
      "month": 0
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Delete Agent

Remove a specific agent from the system, permanently deleting their profile and associated data.

DELETE/workspaces/{workspaceId}/agents/{agentId}

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Get Agent

Retrieve information about a specific agent, including their name, bio, status.

GET/workspaces/{workspaceId}/agents/me

Authorization

useraccessKey

Path parameters

workspaceId*string

Response

200404

OK

Body

application/json

id*string

statusAgentStatus (enum)

activeawayout-of-office

statusBeforeOfflineAgentStatus (enum)

activeawayout-of-office

namestring

overrideNameboolean

workspaceId*string

typeenum

user

userEmailsarray of string

biostring

avatarUrlstring

dropVmsarray of object

tagCountinteger

wrapUpTimeinteger

lastAssignedAtstring (date-time)

lastSetToAwayAtstring (date-time)

teamsarray of object

workloadAgentWorkload (object)

createdAt*string (date-time)

updatedAt*string (date-time)

availabilityAgentAvailability (object)

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

rolesarray of RoleReference

usernullable object

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedSkillsnullable array of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/me', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": false,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    {
      "name": "text",
      "playback": {
        "media": [
          "text"
        ],
        "pauseMilliseconds": 0
      },
      "say": {
        "text": "text",
        "voice": "text",
        "locale": "en-US"
      }
    }
  ],
  "tagCount": 0,
  "wrapUpTime": 0,
  "lastAssignedAt": "2024-12-22T01:44:41.288Z",
  "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2024-12-22T01:44:41.288Z",
      "activeMemberCount": 0,
      "pendingMemberCount": 0
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 0,
      "email": 0
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": false,
      "capacity": {
        "messaging": 0,
        "email": 0
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "createdAt": "2024-12-22T01:44:41.288Z",
  "updatedAt": "2024-12-22T01:44:41.288Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 0,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": false,
    "number": "text",
    "maskCaller": false
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "tuesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "wednesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "thursday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "friday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "saturday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "sunday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 0,
      "month": 0
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Update Agent

Modify the details of a specific agent, such as their name, bio, status.

PATCH/workspaces/{workspaceId}/agents/me

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

nameproperties-name (string)

biobio (string)

statusAgentStatus (enum)

activeawayout-of-office

avatarUrlproperties-avatarUrl (string)

dropVmsdropVms (array of object)

wrapUpTimeinteger

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

weeklyScheduleWeeklySchedule (object)

holidaysarray of Holiday (object)

assignedSkillsarray of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Response

200404422

Updated

Body

application/json

id*string

statusAgentStatus (enum)

activeawayout-of-office

statusBeforeOfflineAgentStatus (enum)

activeawayout-of-office

namestring

overrideNameboolean

workspaceId*string

typeenum

user

userEmailsarray of string

biostring

avatarUrlstring

dropVmsarray of object

tagCountinteger

wrapUpTimeinteger

lastAssignedAtstring (date-time)

lastSetToAwayAtstring (date-time)

teamsarray of object

workloadAgentWorkload (object)

createdAt*string (date-time)

updatedAt*string (date-time)

availabilityAgentAvailability (object)

timezonestring

defaultCountryCodestring

defaultCallerIdstring

forwardNumberAgentForwardNumber (object)

transcriptionLocaleSupportedLocales (enum)

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

rolesarray of RoleReference

usernullable object

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedSkillsnullable array of AgentAssignedSkill (object)

defaultSenderIdstring (uuid)

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/me', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": false,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    {
      "name": "text",
      "playback": {
        "media": [
          "text"
        ],
        "pauseMilliseconds": 0
      },
      "say": {
        "text": "text",
        "voice": "text",
        "locale": "en-US"
      }
    }
  ],
  "tagCount": 0,
  "wrapUpTime": 0,
  "lastAssignedAt": "2024-12-22T01:44:41.288Z",
  "lastSetToAwayAt": "2024-12-22T01:44:41.288Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2024-12-22T01:44:41.288Z",
      "activeMemberCount": 0,
      "pendingMemberCount": 0
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 0,
      "email": 0
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": false,
      "capacity": {
        "messaging": 0,
        "email": 0
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "createdAt": "2024-12-22T01:44:41.288Z",
  "updatedAt": "2024-12-22T01:44:41.288Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 0,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2024-12-22T01:44:41.288Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": false,
    "number": "text",
    "maskCaller": false
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "tuesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "wednesday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "thursday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "friday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "saturday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    },
    "sunday": {
      "from": {
        "hour": 0,
        "minute": 0
      },
      "to": {
        "hour": 0,
        "minute": 0
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 0,
      "month": 0
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "valueType": "single",
      "selectedValues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text"
        }
      ]
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get Agent Availability

Retrieve information about availability of a specific agent.

GET/workspaces/{workspaceId}/agents/{agentId}/availability

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

200404

OK

Body

application/json

statusAgentStatus (enum)

activeawayout-of-office

activityAgentAvailabilityActivity (enum)

availablein-callbusywrap-up-timedo-not-disturbofflinenot-availableout-of-hourscustom

activityTtlinteger

activityTextstring

lastStatusSetstring

lastActivitySetstring

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/availability', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "status": "active",
  "activity": "available",
  "activityTtl": 0,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2024-12-22T01:44:41.288Z"
}

Update Agent Availability

Modify the availability of a specific agent.

PATCH/workspaces/{workspaceId}/agents/{agentId}/availability

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Body

application/json

status*AgentStatus (enum)

activeawayout-of-office

activityAgentAvailabilityActivity (enum)

availablein-callbusywrap-up-timedo-not-disturbofflinenot-availableout-of-hourscustom

activityTtlinteger

activityTextstring

Response

200404422

Updated

Body

application/json

statusAgentStatus (enum)

activeawayout-of-office

activityAgentAvailabilityActivity (enum)

availablein-callbusywrap-up-timedo-not-disturbofflinenot-availableout-of-hourscustom

activityTtlinteger

activityTextstring

lastStatusSetstring

lastActivitySetstring

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/availability', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "active"
    }),
});
const data = await response.json();

Response

200404422

{
  "status": "active",
  "activity": "available",
  "activityTtl": 0,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2024-12-22T01:44:41.288Z"
}

Get Agent Workload

Retrieve information about workload of a specific agent.

GET/workspaces/{workspaceId}/agents/{agentId}/workload

Authorization

useraccessKey

Path parameters

workspaceId*string

agentId*string

Response

200404

OK

Body

application/json

idstring

workloadAgentWorkloadCapabilities (object)

ruleCapacityRule (object)

ruleIdstring

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/agents/{agentId}/workload', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "workload": {
    "messaging": 0,
    "email": 0
  },
  "rule": {
    "id": "text",
    "workspaceId": "text",
    "name": "text",
    "description": "text",
    "default": false,
    "capacity": {
      "messaging": 0,
      "email": 0
    },
    "assignedAgentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "createdAt": "text",
    "updatedAt": "text"
  },
  "ruleId": "text",
  "updatedAt": "2024-12-22T01:44:41.288Z"
}