.png?sv=2022-11-02&spr=https&st=2025-06-07T19%3A47%3A40Z&se=2025-06-07T19%3A57%3A40Z&sr=c&sp=r&sig=b%2FKQLHbEmo99uizhbQvpDrZRJ5DOolKGySnX2gzNrMg%3D){kind=logo}
Get Campaign Time Zone
- DarkLight
Get Campaign Time Zone
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCampaignTimeZone API fetches the time zone of a contact based on the LCMKey.
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCampaignTimeZone |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | LCM Key. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | CampaignTimeZone |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Campaign time zone data. |
Response Parameters | |||
ZoneName | Yes | String | The time zone name. |
CampaignTime | Yes | String | The current campaign time. |
ServerTime | Yes | String | The current server time. |
Possible Error Cases
Error Type | Actual Error | Message |
|---|---|---|
WS_Error | Callid is empty | Invalid Call ID. |
WS_Error | Invalid Call ID:<call_id> | Invalid Call ID. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetCampaignTimeZone",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "CampaignTimeZone",
"message":
{
"callid": "12345",
"response":
{
"ZoneName": "(UTC) Coordinated Universal Time",
"CampaignTime": "07/06/2020 13:42:30",
"ServerTime": "07/06/2020 13:42:30"
}
}
}Was this article helpful?