Basic Management API

Agent Management

● Query Agent Setting

Description: Query the agent's extension account /phone number/sorting duration.

API URL: https://sg.sobot.io/callservice/v6/cc-config/api/agents?agentType={agentType}&agent={agent}
Request The method is as follows : GET

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (query string)

Param	Type	Required	Description
agent	String	Yes	Agent UUID/work no.
agentType	int	Yes	Agent param type. 0: Agent work no., 1: Agent uuid

Return param

Param	Type	Required	Description
agentUUID	String	Yes	Agent UUID
agentID	String	Yes	Agent work no.
agentName	String	No	Agent name
ext	String	No	Binding Extension No.
phone	String	No	Bind Phone No.
wrapUpType	int	No	Post-call sorting type. 1: Overall, 2: Individual
wrapUpTime	int	No	Post-call sorting duration (s)

Response example:

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "ok",
  "code": 200,
  "reason": "OK",
  "kind": "Agent",
  "data": {
    "agentUUID":"bd4630df3550552ba7c16f27ae9a39cb",  // Agent UUID
    "agentID": "1111",  // Agent work no.
    "agentName": "test",  // Agent name
    "phone":"13800138000",  // Agent phone no.
    "ext":"1000",     // Agent extension no.
    "wrapUpType": 2,  //  1: Overall, 2: Individual
    "wrapUpTime":60  // Sorting duration (s)
  }
}

● Modify Agent Setting

Description: Set the agent's corresponding extension account /phone number/sorting duration when the agent provides the phone service.

API URL: https://sg.sobot.io/callservice/v6/cc-config/api/agents
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agent	String	Yes	Agent UUID/work no.
agentType	int	Yes	Agent param type. 0: Agent work no., 1: Agent uuid
wrapUpTime	int	Yes	Post-call sorting time
phone	String	No	Phone No.
ext	String	No	Ext. No.
wrapUpType	int	No	Post-call sorting type. 1: Overall, 2: Individual

Return param

Param	Type	Required	Description
agentName	String	Yes	Agent name
ext	String	Yes	Binding Extension No.
phone	String	Yes	Bind Phone No.
wrapUpType	int	Yes	Post-call sorting type. 1: Overall, 2: Individual
wrapUpTime	int	Yes	Sorting duration (s)
agentUUID	String	No	Agent UUID
agentID	String	No	Agent work no.

Response example:

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "ok",
  "code": 200,
  "reason": "OK",
  "kind": "Agent",
  "data": {
    "agentUUID":"bd4630df3550552ba7c16f27ae9a39cb",  // Agent UUID
    "agentID": "1111",  // Agent work no.
    "agentName": "test",  // Agent name
    "phone":"13800138000",  // Agent phone no.
    "ext":"1000",     // Agent extension no.
    "wrapUpType": 2,  //  1: Overall, 2: Individual 
    "wrapUpTime":60  // Sorting duration (s)
  }

}

● Unbind Agent Setting

Description Unbind agent setting
API URL: https://sg.sobot.io/callservice/v6/cc-config/api/agents/unbind
Request The method is as follows : POST

Request (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agent	String	Yes	Agent UUID/work no.
agentType	int	Yes	Agent param type. 0: Agent work no., 1: Agent uuid
numberType	int	No	Number type. 0: Extension no., 1: Phone no., 2: Telephone no.+phone no.

Return param

Param	Type	Required	Description
agentUUID	String	Yes	Agent UUID
agentID	String	No	Agent work no.
agentName	String	No	Agent name
ext	String	No	Binding Extension No.
phone	String	No	Bind Phone No.
wrapUpType	int	No	Post-call sorting type. 1: Overall, 2: Individual
wrapUpTime	int	No	Post-call sorting duration (s)

Response example:

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "ok",
  "code": 200,
  "reason": "OK",
  "kind": "Agent",
  "data": {
    "agentUUID":"bd4630df3550552ba7c16f27ae9a39cb",  // Agent UUID
    "agentID": "1111",  // Agent work no.
    "agentName": "test",  // Agent name
    "phone":"13800138000",  // Agent phone no.
    "ext":"1000",     // Agent extension no.
    "wrapUpType": 2,  // 1: Overall, 2: Individual
    "wrapUpTime":60  // Sorting duration (s)
  }

}

● Query Call Agent List

Description: Query all enterprise agents with call permissions.
API URL: https://sg.sobot.io/callservice/v6/cc-config/api/agents/call/_search
Request The method is as follows : POST

Request (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agentName	String	No	Agent name (fuzzy query is available)
agentID	String	No	Agent work no. (fuzzy query is available)
queue	String	No	Skill group no. (fuzzy query is unavailable)
ext	String	No	Binding extension no. (fuzzy query is available)
agentStatus	int	No	Agent work status

Return param

• List set

Param	Type	Required	Description
agentUUID	String	Yes	Agent UUID
agentID	String	No	Agent work no.
agentName	String	No	Agent name
ext	String	No	Ext. No.
agentPhone	String	No	Phone no.
loginStatus	Integer	No	Login status
notReadyReasonCode	Integer	No	Occupied reason
createTime	String	No	Creation Time
updateTime	String	No	Update Time
createTimeMs	long	No	Creation Time (ms)
updateTimeMs	long	No	Update Time (ms)

Response example:

{
  "apiVersion": "6.3",
  "status": "Success",
  "message": "ok",
  "code": 200,
  "reason": "OK",
  "kind": "Agent",
  "data": [{
    "agentUUID":"bd4630df3550552ba7c16f27ae9a39cb",
    "agentID": "1111",
    "agentName": "test01",
    "ext":"1000",
    "agentPhone": "138xxxxxxxx",
    "loginStatus": 1,
    "notReadyReasonCode": 0,
    "createTime":"2022-09-14 10:00:01",
    "updateTime":"2022-09-14 10:00:01",
    "createTimeMs": 1663120801000,
    "updateTimeMs": 1663120801000
  },{
    "agentUUID":"d2a6a9fb2ab2470cba9af6b6774ef858",
    "agentID": "2222",
    "agentName": "test02",
    "ext":"1001",
    "agentPhone": "186xxxxxxxx",
    "loginStatus": 2,
    "notReadyReasonCode":11,
    "createTime": "2022-08-14 12:43:01",
    "updateTime":"2022-09-10 08:31:46",
    "createTimeMs": 1660452181000,
    "updateTimeMs": 1662769906000
  }]

}

Skill Group Management

● Query Call Skill Group List

Description: Query call skill group list

API URL: https://sg.sobot.io/callservice/v6/cc-config/api/queues/_search
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
pageSize	int	No	Page size, 10 by default
currPage	int	No	Page no., 1 by default

Return param

Param	Type	Required	Description
queueID	String	Yes	Skill group no.
queueName	String	No	Skill Group Name

Response example:

{
    "apiVersion":"6.3.0",
    "status":"Success",
    "code":200,
    "message":"Success",
    "reason":"",
    "kind":"QueueInfo",
    "metaData":
    {
    },
    "data":
    {
        "list":
        [
            {
                "queueID":"1111",
                "queueName":"queue1"
            },
         
            {
                "queueID":"2222",
                "queueName":"queue2"
        ],
        "currPage":1,
        "pageSize":50,
        "total":21
    }
}

● Add skill group

API URL：https://sg.sobot.io/callservice/v6/cc-config/api/queue
Request method：POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential, Agent token. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default
language	String	No	en by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
queueName	String	Yes	Skill Group Name
queueID	String	Yes	Skill Group No.
queueWeight	String	NO	Skill group weight

Request body example:

{"queueName":"1130 skill group","queueID":"1234","queueWeight":"1"}

Return param

Param	Type	Description
queueName	String	Skill Group Name
queueID	String	Skill Group No.
queueWeight	String	Skill group weight

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "Success",
    "kind": "ApiQueue",
    "metaData": {},
    "data": {
        "queueName": "1130 skill group",
        "queueID": "1234",
        "queueWeight": "1"
    },
    "retMsg": "Success",
    "retCode": "000000"
}

● Delete skill group

API URL：https://sg.sobot.io/callservice/v6/cc-config/api/queue
Request method：DELETE

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential, Agent token. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default
language	String	No	en by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
queueID	String	Yes	Skill Group No.

Request body example:

{"queueID":"1234"}

Return param

Param	Type	Description

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "Success",
    "kind": "QueueInfo",
    "metaData": {},
    "data": {},
    "retMsg": "Success",
    "retCode": "000000"
}

● Query skill group members

API URL：https://sg.sobot.io/callservice/v6/cc-config/api/queue/agents/search
Request method：POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential, Agent token. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default
language	String	No	en by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agentType	String	No	Agent param type. 0: Agent work no., 1: Agent uuid
queueID	String	No	Skill Group No.

Request body example:

{"queueID":"1234","agentType":"1"}

Return param

Param	Type	Description
queueName	String	Skill Group Name
queueID	String	Skill Group No.
queueWeight	int	Skill group weight
agentCount	int	Number of agents in skill group
agents	List	Agent collection info

Agent collection

Param	Type	Description
agent	String	The work no. or ID of the agent is controlled by the input agentType
agentName	String	Agent name
level	String	Agent skill value
checkin	Boolean	Whether to automatically log in

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "Success",
    "kind": "List",
    "metaData": {},
    "data": [
        {
            "queueName": "Group1",
            "queueID": "0000",
            "queueWeight": 0,
            "agentCount": 6,
            "agents": [
                {
                    "agent": "cef499bccbf44e11a6e78d398cfcce53",
                    "agentName": "nicole",
                    "level": "1",
                    "checkin": false
                },
                {
                    "agent": "0d0132473a7f46c390d1f6441c139980",
                    "agentName": "venus",
                    "level": "1",
                    "checkin": true
                },
                {
                    "agent": "4bd9716e859f4cdaa58218d97776eb0e",
                    "agentName": "odin",
                    "level": "1",
                    "checkin": true
                },
                {
                    "agent": "5f98ae6f03ca48c1a9d36d747a736211",
                    "agentName": "zane",
                    "level": "1",
                    "checkin": true
                },
                {
                    "agent": "f3cf4f25fa12483d81cbb764e4b2dfb6",
                    "agentName": "ndidn",
                    "level": "1",
                    "checkin": true
                },
                {
                    "agent": "0910ba8d7bd243a5aa86f0b5bbc77b10",
                    "agentName": "patton",
                    "level": "1",
                    "checkin": true
                }
            ]
        }
    ],
    "retMsg": "Success",
    "retCode": "000000"
}

● Update skill groups in bulk

API URL：https://sg.sobot.io/callservice/v6/cc-config/api/queue/agents
Request method：POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential, Agent token. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default
language	String	No	en by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agentType	String	No	Agent param type. 0: Agent work no., 1: Agent uuid
list	List	No	Queue collection info

Queue collection

Param	Type	Required	Description
queueID	String	Yes	Skill Group No.
queueName	String	No	Skill Group Name
queueWeight	String	No	Skill group weight
add	List	No	Collection of new or overwritten agent info
remove	List	No	Collection of agent of removed skill group

Agent collection

Param	Type	Required	Description
agent	String	Yes	The work no. or ID of the agent is controlled by the input agentType
level	Integer	No	Agent skill value
checkin	Boolean	No	Whether the agent automatically logs in

Request body example:

{
    "list": [{
            "queueID": "3455",
            "queueWeight": "0",
            "queueName": "skill group 1",
            "add": [{
                    "agent": "69351d38049342d38fad2b3a645d574f",
                    "level": 1,
                    "checkin": true
            }],
            "remove": [{
                    "agent": "3c7498a22d55447aa80344ab1f0e9e59",
                    "level": 1,
                    "checkin": true
            }]
    }]
}

Return param

Param	Type	Description
agentType	String	Agent param type. 0: Agent work no., 1: Agent uuid
list	List	Queue collection info

Queue collection

Param	Type	Description
queueID	String	Skill Group No.
queueName	String	Skill Group Name
queueWeight	String	Skill group weight
add	List	Collection of new or overwritten agent info
remove	List	Collection of agent of removed skill group

Agent collection

Param	Type	Description
agent	String	The work no. or ID of the agent is controlled by the input agentType
level	Integer	Agent skill value
checkin	Boolean	Whether to automatically log in

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "Success",
    "kind": "ApiQueueAgent",
    "metaData": {},
    "data": {
        "agent": null,
        "agentType": "1",
        "operator": null,
        "list": [
            {
                "queueID": "1234",
                "queueName": "skill group 1",
                "queueWeight": "0",
                "add": [
                    {
                        "agent": "01651b3a13b94d7d86a20800544895e0",
                        "level": 1,
                        "checkin": true
                    }
                ],
                "remove": [
                    {
                        "agent": "0910ba8d7bd243a5aa86f0b5bbc77b10",
                        "level": 1,
                        "checkin": true
                    }
                ]
            }
        ]
    },
    "retMsg": "Success",
    "retCode": "000000"
}

Extension Management

● Query Extension List

Description: Query extension list

API URL: https://sg.sobot.io/callservice/v6/cc-config/api/exts/_search
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
bindStatus	int	No	Binding status. 0: Not bound, 1: Bound
pageSize	int	No	Page size, 10 by default
currPage	int	No	Page no., 1 by default

Return param

Param	Type	Required	Description
ext	String	Yes	Ext. No.
password	String	Yes	Extension password
bindStatus	String	Yes	Binding status. 0: Not bound, 1: Bound
bindTime	long	No	Binding time (ms)
agentUUID	String	No	Agent‘s unique id
agentName	String	No	Agent name

Response example:

{
    "apiVersion": "6.3.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "Ext",
    "metaData": {},
    "data": {
        "list": [
            {
                "ext":"5002",
                "password": "123456",
                "bindStatus": 1,
                "bindTime":  1657274393279 ,
                "agentUUID":"7b8ec043e9a24727ad0570ba1b6e82fe",
                "agentName": "v6_cs2"
            },
            {
                "ext":"5001",
                "password": "123456",
                "bindStatus": 1,
                "bindTime":  1657682876629 ,
                "agentUUID":"59220de7f88141829a1f38d8698acb26",
                "agentName": "v6_cs1"
            }
        ],
        "currPage": 1,
        "pageSize": 3,
        "total": 13
    }
}

● Create an extension account

Description: Create an extension account

API URL: https://sg.sobot.io/callservice/v6/cc-config/api/exts/_add
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
agentID	String	Yes	Agent work no. or agent id.
agentType	String	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
ext	String	Yes	Extension account, 3-8-digit number combination; it can start with 0; it cannot be changed after creation
password	String	Yes	Extension password, 6-8-digit numbers for registering physical phone

Return param

Param	Type	Required	Description
ext	String	Yes	Ext. No.
password	String	Yes	Extension password
langCodeTxt	String	Yes	Voice code format

Response example:

{
    "apiVersion": "6.3.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "Ext",
    "metaData": {},
    "data": {
        "ext": "5002",
        "password": "123456",
        "langCodeTxt": "Opus"
    }
}

Number Management

● Import Enterprise Forbidden No.

API URL ：https://sg.sobot.io/callservice/v6/cc-config/blacklist/batch
Request method: PUT

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
callNumber	String	Yes	Phone no.
numberType	int	Yes	1: Phone no.
callType	int	Yes	Call direction. 2: Inbound, 3: Outbound
enabled	int	Yes	Enabling status. 0: Disable, 1: Enable
expirationTime	String	No	Expiry time：yyyy-MM-dd
zoneId	String	No	Zoneid：Refer to the currently available time zone of the company, and the default time zone of the enterprise will be used if not passed
description	String	No	Description

Return param

Param	Type	Required	Description
successCount	int	Yes	Number of the imported
failedCount	int	No	Number of the failed import
details	Array	No	Array element. Please refer to Data of Enterprise Forbidden No. Import Failure

Request example:

[   
    {
        "callNumber":"15210818952",  // Call number
        "numberType": 1,  // Number type. 1-Number
        "callType": 2,    // Call direction. 2-Inbound, 3-Outbound
        "enabled": 0,    // Enabling status. 0-Disable, 1-Enable
        "description": "test1"// Description
    },
    {
        "callNumber":"13212341232",
        "numberType": 2,
        "callType": 2,
        "enabled": 0,
        "description": "test2"
    },
    {
        "callNumber":"13212341233",
        "numberType": 2,
        "callType": 2,
        "enabled": 0,
        "description": "test3"
    }
] 

Response example:

{
    "apiVersion":"6.2",
    "status":"Success",
    "code":200,
    "message":"Success",
    "reason":"",
    "kind":"BatchDetail",
    "metaData":{},
    "data":
    {
        "successCount":3,  
        "failedCount":2, 
        "details":
        [
           "NO[2]，[numberType]，Content[2]，[Reference：1-number]",
           "NO[3]，[numberType]，Content[2]，[Reference：1-number]"
        ]
    }
}

● Query relay number list

API URL：https://sg.sobot.io/callservice/v6/cc-config/api/gatewayNumber/search
Request method：POST

Request param (header): :

Param	Type	Required	Description
Authorization	String	Yes	API access credential, Agent token. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default
language	String	No	en by default

Request param (body)

• content-type: application/json;charset=utf-8
• Param Description

Param	Type	Required	Description
enabled	List	No	Number enabled status: 0 – disabled; 1 – enabled; 2 – cancelled. Multiple choices are supported. When it is null, the default value is “enabled”

Request body example:

{"enabled":[1,2,0]}

Return param

Param	Type	Description
data	List	Relay number set

Relay number

Param	Type	Description
gatewayNumber	String	Relay number
alias	String	Alias
remark	String	Notes
enabled	Map	Number enabled status

Map

Param	Type	Description
enabledCode	Integer	Number enabled status number
enabledName	String	Number enabled status name

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "Success",
    "kind": "List",
    "metaData": {},
    "data": [
        {
            "gatewayNumber": "010514294XX",
            "alias": "nick’s",
            "remark": "Nick often uses this",
            "enabled": {
                "enabledCode": 1,
                "enabledName": "Enabling"
            }
        },
        {
            "gatewayNumber": "010514294XX",
            "alias": "Lily",
            "remark": "no use",
            "enabled": {
                "enabledCode": 2,
                "enabledName": "Cancelled"
            }
        }
    ],
    "retMsg": "Success",
    "retCode": "000000"
}

Outbound Task

● Create Outbound Task

API Address: https://sg.sobot.io/callservice/v6/cc-outbound/api/campaigns

Request method: POST

Request param (header)

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
Idempotency-Key	String	Yes	UUID, idempotency
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8

Param	Type	Required	Description
agentID	String	Yes	Agent work no. or agent id. The value is determined by the agentType value.
agentType	String	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
name	String	Yes	Task name
dataTemplateCode	String	Yes	Code of import template with an enabled status
wrapUpTemplateCode	String	Yes	Code of summary template with an enabled status
scheduleStartTime	Long	Yes	Plan start time, timestamp (ms)
scheduleEndTime	Long	Yes	Plan end time, timestamp (ms). It must be greater than the plan start time when it is not blank.
scheduleTimeZoneId	String	No	timeZoneId
description	String	No	The note should be 1000 chars max
taskType	int	No	Task type: 1 Manual outbound call, 2 Robot outbound call. When empty, defaults to manual outbound call task.
robotCode	String	No	Robot code: This field is required when the task type is 'outbound robot call'.
robotNum	int	No	Maximum concurrent robots: This field is required when the task type is 'outbound robot call'.
explicitType	int	No	Display mode: 1 - Display number, 2 - Dynamic display plan. This field is required when the task type is 'outbound robot call'.
aniList	List	No	Display number: This field is required when the task type is 'outbound robot call' and the display mode is 'fixed display number
aniPlanCode	String	No	Dynamic display plan: This field is required when the task type is 'outbound robot call' and the display mode is set to '2 - dynamic display plan'.
priority	int	No	Priority: 1 - Low, 2 - Medium, 3 - High. This field is required when the task type is 'outbound robot call'. Valid values: Low, Medium, High. If left empty, the default priority is Medium.
callTimeType	int	No	Call time period: 1 - All time, 2 - Selected time plan. This field is required when the task type is 'outbound robot call'. Time plans are configured in the admin console and up to 3 plans can be specified. If left empty, calls are allowed at any time.
timePlanCodes	List	No	Time plan code: This field is required when the task type is 'outbound robot call' and the display mode is set to '2 - dynamic display plan'.
taskRetryConfig	Json	No	Redial strategy: This field is applicable only when the task type is 'outbound robot call' (it is not valid for manual outbound tasks). The redial strategy is defined as an array, currently supporting only one strategy group.

taskRetryConfig

Param	Type	Required	Description
retryNum	int	No	Retry attempts, value range: 1, 2
retryTime	int	No	Retry interval time (minutes), value range: 3, 10, 30, 60, 90, 120
retryCondition	List	No	Redial conditions: 3 No answer, 4 Powered off, 5 Service suspended, 7 User rejected, 9 User busy

Request body example:

{
    "agentID":"59220de7f88141829a1f38d8698acb26",
    "agentType": "1",
    "name": "Announcement",
    "dataTemplateCode": "D000000000",
    "wrapUpTemplateCode": "W000000000",
    "scheduleStartTime": 1660115936310,
    "scheduleEndTime": 1660118400638,
    "scheduleTimeZoneId":"Pacific/Midway",
    "description": "Description",
    "robotCode":"xxxx",
    "robotNum":2,
    "explicitType":1,
    "aniList":["01033xxx","01044xxx"],
    "callTimeType":1,
    "taskRetryConfig":{
      "retryNum":1,
      "retryTime":3,
      "retryCondition":[3,4]
    }
}

Return param

Param	Type	Required	Description
id	String	Yes	Campaign ID
code	String	Yes	Code

Response example

{
    "apiVersion": "6.3.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "ApiRespCampaignsVO",
    "metaData": {},
    "data": {
        "id":"037276ff01c6eM4b1b89413A383072f38476",
        "code": "dgug92owec"
    }
}

● Outbound Task Import Data

API Address: https://sg.sobot.io/callservice/v6/cc-exports/api/campaigns/_import

Request method: POST

QPS Limit: The QPS limit for a single user of this API is as follows: (data<=10: 1 time/second; 10<data<=100: 1 time/5 seconds; 100<data<=1000: 1 time/20 seconds). If the limit is exceeded, the API call will be throttled. Please use it appropriately.

Request param (header)

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
Idempotency-Key	String	Yes	UUID, idempotency
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8

Param	Type	Required	Description
agentID	String	Yes	Agent work no. or agent id. The value is determined by the agentType value;
agentType	String	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
campaignId	String	No	Campaign ID. The creator should be the agent currently importing data (API param); otherwise, it is unavailable.
code	String	No	Code. when outbound Campaign ID is not blank, outbound Campaign ID field is used as primary key of the task for the API to inquire task records.When outbound Campaign ID is blank, and code is not blank, code field is used as primary key of the task for the API to inquire task records.
callingListCode	String	Yes	Batch no. It should be at most a 20-digit combination of letters and numbers and cannot be modified after being entered.
removeDuplicatesRule	String	Yes	Number duplicate removal rules NonRemoveDuplicates (not remove Duplicate); RemoveDuplicatesInCallingList (remove duplicate in batch); RemoveDuplicatesInCampaign (remove duplicate in task); RemoveDuplicatesInTenan t(remove duplicate among tasks,not supported for robot outbound calls.)
enableFilterDoNotCallListNumber	String	No	Whether to filter forbidden no. Filter (filter); NoFilter (not filter); NoFilter by default.
assignRule	String	Yes	Assignment method. AssignAverage (average assignment), AssignAppoint (designated assignment), NoAssign (no assignment) When the task type is a robot outbound call, this field is empty.
assignAgentAndCount	json	No	Assigned agent When the task type is a robot outbound call, this field is empty.

assignAgentAndCount

Param	Type	Required	Description
agentID	String	Yes	Agent ID
count	String	Yes	Quantity

Param	Type	Required	Description
dataDetails	array json	Yes	Import outbound task data details. The maximum number of data entries imported per batch for bot outbound tasks is 1000.

dataDetails

Param	Type	Required	Description
telephone	String	Yes	Detail number
allocationAgent	String	No	Assigned agent (work no.)
name	String	No	Detail name
customFields	array json	No	Custom field. See the custom field set of task import template for details.

customFields

Param	Type	Required	Description
fieldId	String	Yes	Custom ID
fieldValue	String	Yes	Custom value

Request body example:

{
    "agentID":"e906cc52bfac44b4ae30497fd39c4c4d",
    "agentType": "1",
    "campaignId":"cde0f90801d98M4fcb8a43eFff11b201cbff",
    "callingListCode": "20220815203412",
    "removeDuplicatesRule": "RemoveDuplicatesInCallingList",
    "enableFilterDoNotCallListNumber": "Filter",
    "assignRule":"AssignAppoint",
    "assignAgentAndCount": [{
        "agentID":"2b82a4acc60647dd814b3db642e75972",
        "count": 100
    }],
    "dataDetails": [{
        "allocationAgent": "12001",
        "name": "Rason",
        "telephone":"100000000",
        "description":"desc1",
        "customFields": [{
            "fieldId":"3b987930e6db4b0ca51f6ad5755e91ae",
            "fieldValue":"Admin"
        }]
    }]

}

Return param

Param	Type	Required	Description
callingListCode	String	Yes	Batch no. Query import results by batch ID
campaignId	String	Yes	Campaign ID
code	String	Yes	Code

Response example

{
    "apiVersion": "6.3.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "ApiRespCampaignsVO",
    "metaData": {},
    "data": {
        "campaignId":"2b82a4acc60647dd814b3db642e75971",
        "callingListCode": "20220101000000",
        "code":"dgug92owec"
    }
}

● Batch Import Result Query

API Address: https://sg.sobot.io/callservice/v6/cc-outbound/api/campaigns/calling-list/import-result

Request method: POST

Request param (header)

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
Idempotency-Key	String	Yes	UUID, idempotency
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

• content-type: application/json;charset=utf-8

Param	Type	Required	Description
agentID	String	Yes	Agent work no. or agent id. The value is determined by the agentType value;
agentType	String	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
callingListCode	String	No	Batch no., returned by import task data API
campaignId	String	No	Campaign ID, returned by import task data API
code	String	No	Code. when outbound Campaign ID is not blank, outbound task ID field is used as primary key of the task for the API to inquire task records.When outbound task ID is blank, and code is not blank, code field is used as primary key of the task for the API to inquire task records.
currPage	int	No	Current page, 1 by default
pageSize	int	No	Pieces on each page, 50 by default

Request body example:

{
    "agentID":"59220de7f88141829a1f38d8698acb26",
    "agentType": "1",
    "callingListCode":"02951e5b01ddcM40997b185S2a541d16be48",
    "campaignId":"2b82a4acc60647dd814b3db642e75971",
    "code":"dgug92owec",
    "currPage": 1,
    "pageSize": 50

}

Return param

Param	Type	Required	Description
campaignId	String	Yes	Campaign ID
code	String	Yes	Code
callingListCode	String	Yes	Batch no.
creationTime	Long	Yes	Import time, timestamp (ms)
removeDuplicatesRule	String	Yes	Number duplicate removal rule
successCount	int	Yes	Succeeded task details
repeatCount	int	Yes	Repeated task details
errorCount	int	Yes	Failed task details
errorReportPath	String	Yes	Error report download URL

Response example

{
    "apiVersion":"v6.3.0",
    "status":"Success",
    "code":200,
    "message":"Success",
    "reason":"",
    "kind":"ApiRepsICallListResult",
    "metaData":{

    },
    "data":{
        "totalCount":13,
        "pageSize":50,
        "totalPage":1,
        "currPage":1,
        "list":[
            {
                "campaignId":"cde0f90801d98M4fcb8a43eFff11b201cbff",
                "code":"dgug92owec",
                "callingListCode": "20220815203412",
                "removeDuplicatesRule": "RemoveDuplicatesInCallingList",
                "successCount":1,
                "errorCount":0,
                "errorReportPath":"https://img-sg.sobot.io/cc/36a97af88e194c54923484b81adaaa1e/costExport/import/campaigns/20230125/b38de85b0f9d1N43781ab03P89c56729924a/1674654321082757_0619826b0e024N4650194b8P87a660372bfb.xlsx",
                "removeDuplicatesCount":0,
                "creationTime": 1660632449700
            }
        ]
    }
}

● Query outbound task list

Description：Query outbound task list of enterprise agent API URL: https://sg.sobot.io/callservice/v6/cc-outbound/api/campaigns/getList
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
Idempotency-Key	String	Yes	UUID, idempotency

Request param (body)

• content-type: application/json;charset=utf-8

Param	Type	Required	Description
code	String	No	No.
creationTimeStart	Long	Yes	Creation start time (time period not exceeding 12 months,timestamp in milliseconds)
creationTimeEnd	Long	Yes	Creation end time (Timestamp in milliseconds)
agentUUID	String	NO	Agent work no. or agent ID
agentType	String	NO	1: Agent ID; 0/blank: Agent work no.
pageSize	int	Yes	Page size
currPage	int	Yes	Page
taskType	int	No	Task type: 1 Manual outbound call, 2 Robot outbound call. When empty, defaults to manual outbound call task.

Return param

• List collection

Param	Type	Required	Description
code	String	Yes	Task no.
name	String	Yes	Task name
scheduleStartTime	Long	Yes	Scheduled start time
scheduleEndTime	Long	Yes	Scheduled close time
scheduleTimeZoneId	String	No	Time zone ID
scheduleStartTimeZoneValue	String	No	Time zone start
scheduleEndTimeZoneValue	String	No	Time zone end
state	Integer	Yes	Execute status
expired	Integer	No	Expiration status
description	String	No	Note
creationTime	Long	Yes	Creation time
contactRecordCount	Integer	Yes	Task details
contactUnassignedCount	Integer	Yes	Unassigned
agentCount	Integer	Yes	Assigned agents
contactRecordExecuteCount	Integer	Yes	Number of calls made
contactExecuteRate	String	Yes	Task detail execution %
contactRecordAnswerCount	Integer	Yes	Number of answered calls
contactAnswerRate	String	Yes	Task detail answer %
callDialCount	Integer	Yes	No. of outbound calls
callAnswerCount	Integer	Yes	No. of answered outbound calls
callAnswerRate	String	Yes	% of answered outbound calls
callTalkDuration	Integer	Yes	Talk duration
averageCallTalkDuration	Integer	Yes	Avg. talk duration
priority	Integer	Yes	Priority: 1 - Low, 2 - Medium, 3 - High. This field is required when the task type is 'outbound robot call'. Valid values: Low, Medium, High.
taskStatus	String	Yes	Call status: '1' - None, '2' - Waiting for concurrency, '3' - Waiting for call time window, '5' - Calling. Required when the task type is 'outbound robot call'.
robotCode	String	Yes	Robot code. Required when the task type is 'outbound robot call'.
robotNum	Integer	Yes	Maximum number of concurrent robots. Required when the task type is 'outbound robot call'.
sysInterceptCount	Integer	Yes	Number of customers intercepted by the system. Required when the task type is 'outbound robot call'.
lineInterceptCount	Integer	Yes	Number of customers intercepted by the phone line. Required when the task type is 'outbound robot call'.
sysInterceptRate	String	Yes	Percentage of customers intercepted by the system. Required when the task type is 'outbound robot call'.
lineInterceptRate	String	Yes	Percentage of customers intercepted by the phone line. Required when the task type is 'outbound robot call'.
effectiveCustomerResponseRate	String	Yes	Effective customer answer rate. Required when the task type is 'outbound robot call'.
runningRobotCounts	Integer	Yes	Number of robots currently in use (concurrent). Required when the task type is 'outbound robot call'.
updatedTime	Long	Yes	Last updated time.

Response example：

{
    "apiVersion": "v6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "RespCampaignsVO",
    "metaData": {},
    "data": {
        "totalCount": 1,
        "pageSize": 50,
        "totalPage": 1,
        "currPage": 1,
        "list": [
            {
                "code": "6yoq3b0lpf",
                "name": "1111123",
                "timed": 0,
                "scheduleStartTime": 0,
                "scheduleEndTime": 0,
                "scheduleTimeZoneId": null,
                "scheduleStartTimeZoneValue": null,
                "scheduleEndTimeZoneValue": null,
                "state": 1,
                "expired": null,
                "description": "",
                "creationTime": 1711681298345,
                "contactRecordCount": 0,
                "contactUnassignedCount": 0,
                "agentCount": 0,
                "contactRecordExecuteCount": 0,
                "contactRecordAnswerCount": 0,
                "contactExecuteRate": "0.00%",
                "contactAnswerRate": "0.00%",
                "callDialCount": 0,
                "callAnswerCount": 0,
                "callAnswerRate": "0.00%",
                "callTalkDuration": 0,
                "averageCallTalkDuration": 0,
              	"priority":2,
                "taskStatus":1,
                "robotCode":"123",
                "robotNum":1,
                "sysInterceptCount": 4,
                "lineInterceptCount": 2,
                "sysInterceptRate":"12.12%",
                "lineInterceptRate":"12.12%",
                "contactRecordExecuteCount":3,
                "effectiveCustomerResponseRate":"12.12%",
                "runningRobotCounts":1,
                "updatedTime": 1735531488622
            }
        ]
    },
    "retMsg": "Success",
    "retCode": "000000"
}

● Outbound Task Status Operation

API URL: https://openapi.soboten.com/callservice/v6/cc-outbound/api/campaigns/operate
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
Idempotency-Key	String	Yes	UUID, idempotency

Request param (body)

• content-type: application/json;charset=utf-8

Param	Type	Required	Description
agentID	String	Yes	Agent work no. or agent ID
agentType	String	No	1: Agent ID; 0/blank: Agent work no.
code	String	Yes	Task code. Only exact match is supported.
operateType	String	Yes	Operation type: 'start' (start), 'pause' (pause).

Return param

Param	Type	Required	Description
id	String	Yes	Task ID.
code	String	Yes	Task code
state	Integer	Yes	Execution status: 1 - Not started, 2 - In progress, 3 - Paused, 4 - Closed, 6 - Archived

Response example：

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "HashMap",
    "metaData": {},
    "data": {
        "code": "4jmgw5n7ry",
        "campaignId": "ed9cac95073b6P4a1e59fabKf6924e00ca70",
        "status": 2
    },
    "retMsg": "Success",
    "retCode": "000000"
}

Contact Plan

● Create Contact Plans in Bulk

Description: Create contact plans in bulk, with 50 max for a single time.

API URL: https://sg.sobot.io/callservice/v6/cc-console/contact-schedules/_batchAddInfos
Request The method is as follows : POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token
timezoneid	String	No	ZoneId, Asia/Singapore by default

Request param (body)

Param	Type	Required	Description
name	String	Yes	Contact plan name. 20 valid chars max
bak	String	No	Contact plan note. 200 valid chars max
scheduleStartTime	Long	Yes	Contact plan start time. Timestamp (ms), accurate in minutes ，e.g.：1663986420000（2022- 09 - 24 10 :27: 00 ）
scheduleEndTime	Long	Yes	Contact plan expiry time. Timestamp (ms), accurate in minutes
customerPhoneNumberList	List<String>	Yes	Customer phone no. array. Compliance with 3- to 16-digit rules, with 50 entries max at a time
executorId	String	Yes	Work no. or id of agent executing the contact plan
agentID	String	Yes	Work no. or id of agent creating bulk contact plans
agentType	String	No	Operation user or executor param type. 0: Agent work no., 1: Agent id. Agent work no. by default when it is null
zoneId	String	No	zoneId
zoneValue	String	No	zoneValue

Request body example:

{
    "name": "openApi-batch-plan-5",
    "scheduleStartTime": 1661911780000,
    "scheduleEndTime": 1662998180000,
    "executorId": "5001",
    "bak":"test4444",
    "agentID": "5002",
    "agentType": "0",
    "zoneId":"Asia/Singapore",
    "zoneValue":"GMT+08:00 Singapore",
    "customerPhoneNumberList": [
       "18189672221",
       "18189671111",
       "18889673333"
    ]
}

Return param

Param	Type	Required	Description
data	Array	Yes	Contact plan ids

Response example:

{
    "apiVersion": "v6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Success",
    "reason": "",
    "kind": "List",
    "metaData": {},
    "data": [
       "83f938c7d45ac0e2445ce0f59bc57e59",
       "a29efd4c7d3c2a3f7afac174b7fbefac",
       "c0a8e889945b475d17230592ff35d0a6"
    ]
}

IVR Flow Management

●Example Query published IVR flows

Description：Example Query published IVR flows，with 50 max for a single time.

API URL: https://sg.sobot.io/callservice/v6/cc-ivr/api/ivr/published/_search
Request The method is as follows: POST

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token

Request param (body)

Param	Type	Required	Description
currPage	int	No	Current page, 1 by default
pageSize	int	No	Pieces on each page, 10 by default
operator	String	No	Agent work no. or agent id. The value is determined by the agentType value;
agentType	int	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.

Request body example:

{
    "currPage":1,
    "pageSize":10
}

Return param

• List set

Param	Type	Required	Description
name	String	Yes	name of ivr
code	String	Yes	code of ivr
remarks	String	No	remarks of ivr

Response example:

{
    "apiVersion": "6.0.0",
    "status": "Success",
    "code": 200,
    "message": "Request service done",
    "reason": "Success",
    "kind": "SearchIvrResponse",
    "metaData": {
        "creatorId": null,
        "creationTime": null,
        "updateUserId": null,
        "updatedTime": null
    },
    "data": {
        "list": [
            {
                "name": "test222",
                "code": "4445",
                "remarks": "ssf"
            },
            {
                "name": "test333",
                "code": "1111",
                "remarks": "2222"
            }
        ],
        "currPage": 1,
        "pageSize": 5,
        "total": 33
    },
    "retMsg": "Request service done",
    "retCode": "000000"
}

Common Data Structure

● Data of Forbidden No. Import Failure

Param	Type	Required	Description
detail	String	Yes	E.g.: Entry[3], [callType], content [5], [Refer to: 1-Outbound]

Bot Management

●Example Query bot list

Description：Example Query bot list，with 50 max for a single time.

API URL: https://openapi.soboten.com/callservice/v6/cc-bot/api/bots/_search
Request The method is as follows: POST

QPS Limit: the QPS limit for this interface is 10/second per user. If the limit is exceeded, API calls will be throttled. Please use it appropriately.

Request param (header):

Param	Type	Required	Description
Authorization	String	Yes	API access credential. Please refer to Obtain the Authentication Token

Request param (body)

Param	Type	Required	Description
currPage	Integer	No	Current page, 1 by default
pageSize	Integer	No	Pieces on each page, 10 by default
operator	String	No	Agent work no. or agent id. The value is determined by the agentType value;
agentType	Integer	No	Agent param type, 0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
botType	Integer	No	Bot type, 1: inbound bot; 2: outbound bot. Default query includes all.
botCode	String	No	Bot code

Request body example:

{
    "operator": "9527",
    "agentType": 0,
    "currPage": 1,
    "pageSize": 10
}

Return param

• List set

Param	Type	Required	Description
id	String	Yes	Bot id
botCode	String	Yes	Bot code
botName	String	Yes	Bot name
botType	Integer	Yes	Bot type

Response example:

{
    "apiVersion": "6.0.0", 
    "status": "Success",
    "reason": "",
    "kind": "BotBasicInfoVo",
    "metaData": {},
    "data": {
        "totalCount": 1,
        "pageSize": 10,
        "totalPage": 1,
        "currPage": 1,
        "list": [
            {
                "id": "cc7f1690640446afa7b3df04d892546a",
                "botCode": "0024",
                "botName": "test1",
                "botType": 1
            }
        ]
    },
    "retMsg": "Request service done",
    "retCode": "000000"
}