Create Session

POST https://{{axpAPIDomain}}/api/digital/channel/v1/accounts/:accountId/sessions

Creates a new client session for the customer. A single customer can have multiple active sessions concurrently. For example, if a customer is logged-in through a mobile device and a computer, activities from both the devices can be represented using two separate sessions.

Request Body

{"accountId"=>"{{accountId}}", "channelProviderId"=>"{{digitalChannelProviderId}}", "customerIdentifiers"=>{"emailAddresses"=>["john@example.com"], "phoneNumbers"=>["+91 20 4101 8003"]}, "displayName"=>"John Doe", "sessionParameters"=>{"language"=>"english", "device"=>"mobile", "app"=>"chrome-mobile"}, "providerCustomerId"=>"55", "correlationId"=>"zc38400d-c44f-4451-8316-e75c4efbt779"}

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"sessionId":"10494b78-710c-11eb-9439-0242ac130002","accountId":"{{accountId}}","channelProviderId":"ChatConnector01","displayName":"John Doe","customerIdentifiers":{"emailAddresses":["john@example.com"],"phoneNumbers":["+91 20 4101 8003"]},"sessionParameters":{"language":"english","device":"mobile","app":"chrome-mobile"},"sessionStatus":"ACTIVE","providerCustomerId":"55","createdAt":"2018-11-13T20:25:39.534Z","lastUpdatedAt":"2018-11-13T20:25:39.734Z","url":"https://us.cc.avayacloud.com/api/digital/channel/v1/sessions/10494b78-710c-11eb-9439-0242ac130002"}