Get account

Request

Overview

Use this API to get details of a registered Conversation Manager account.

Scope

Client application must have 'app.conversation.conversationmgr.manage' or 'app.conversation.conversationmgr.read' scope assigned.

Security

oAuthClient(Required scopes: )

Path

idstring, = 36 charactersrequired

id of object

Example:7b6c5fff-036e-4a40-b68a-a67c592fc079

GET

/accounts/{id}

curl -i -X GET \
  https://api.egain.cloud/conversation/conversationmgr/v3/accounts/7b6c5fff-036e-4a40-b68a-a67c592fc079 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

idstring, = 36 characters

createdstring, (date-time)

Last modified time in GMT

modifiedstring, (date-time)

Last modified time in GMT

namestring, [ 1 .. 255 ] charactersrequired

Unique name for account

descriptionstring, [ 1 .. 1023 ] characters

activeboolean

Default:true

addressstring, [ 1 .. 255 ] charactersrequired

Account ID like email address, phone numbers.

channelobjectrequired

caseManagementobject(CaseManagement)

chatConfigurationsobject(ChatConfigurations)required

attributesArray of objects, [ 1 .. 10 ] items(Attribute)

Response

{
  "id": "ae103957-9c82-4fa8-a34e-925be85e06ec",
  "created": "2021-03-21T14:29:01.516Z",
  "modified": "2021-03-28T14:29:01.516Z",
  "name": "order_account",
  "address": "123456789",
  "channel": {
    "id": "45a095f4-d0ee-4220-a689-22b541c58f67"
  },
  "chatConfigurations": {
    "timeout": 30,
    "defaultLanguage": "en-US",
    "onAgentUnavailability": "off_hours",
    "orchestration": { … },
    "entryPoint": { … }
  }
}