Table of Contents
Parameters #
name: {string} The Name of the Team
callMode: {"round robin" or "simultaneous"} The method Call Assist uses to call your Team.
whisperText: {string} Whisper text to play before connecting an agent with a lead. May include lead references {first} {last} {company} {category} {comments}
whisperLanguage: {language} Whisper text language.
"en-US","es-ES","fr-FR","it-IT","de-DE","nl-NL","pt-BR"
recordCall: {boolean} Whether to record the call or not
delay: {Integer} Minutes to delay the call
callback_url: {URL} Url to send call completed events.
optOut: {boolean} Whether to include opt out message at end of lead calls.
members: ["agentId"] or ["agentFirst agentLast"] Array of agent Id's or agent first and last names to include in the group.
Examples:
"members":["160637174875251747683","160748877841248652133"]
"members":["John Smith","Sally Sampson"]
hasSchedule: {boolean} Whether the team has an on-call scheduled.
timezone: {UTC Timezone Name} Timezone names found here.
Example: "America/Vancouver"
Get a Team #
Returns a team object.
GET
https://app.mycallassist.com/api/v1/teams/{teamId}Response
{
"id": "5f97641c3e575400179dc116",
"name": "Alpha Team",
"callMode": "round robin",
"whisperText": "Please press 1 to connect to {first}...",
"whisperLanguage": "en-US",
"recordCall": true,
"delay": 5,
"callback_url": "http://webhookurl.com/s8f8fsfsid7f",
"optOut": false,
"members": [
{
"id": "160637174875251747683"
"first": "John",
"last": "Helloman",
"phone": "15555555555"
}
],
"hasSchedule": true,
"timezone": "America/Vancouver",
"schedule": [
{
"label": "Sunday",
"day": 0,
"is_available": true,
"times": [
{
"start": "09:00:00",
"end": "16:00:00"
}
]
},
{
"label": "Monday",
"day": 1,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Tuesday",
"day": 2,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Wednesday",
"day": 3,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Thursday",
"day": 4,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Friday",
"day": 5,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Saturday",
"day": 6,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
}
],
}Get Teams #
Returns a list of team objects.
GET
https://app.mycallassist.com/api/v1/teams
Response
{
"data":[
{
"id": "5f97641c3e575400179dc116",
"name": "Alpha Team",
"callMode": "round robin",
"whisperText": "Please press 1 to connect to...",
"whisperLanguage": "en-US",
"recordCall": true,
"delay": 5,
"callback_url": "http://webhookurl.com/s8f8fsfsid7f",
"optOut": false,
"members":[
{
"id":"160637174875251747683",
"first":"John",
"last":"Helloman",
"phone":"15555555555"
}
],
"hasSchedule": true,
"timezone": "America/Vancouver",
"schedule":[
{
"label":"Sunday",
"day":0,
"is_available":true,
"times":[
{
"start":"09:00:00",
"end":"16:00:00"
}
]
},
{
"label":"Monday",
"day":1,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
},
{
"label":"Tuesday",
"day":2,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
},
{
"label":"Wednesday",
"day":3,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
},
{
"label":"Thursday",
"day":4,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
},
{
"label":"Friday",
"day":5,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
},
{
"label":"Saturday",
"day":6,
"is_available":true,
"times":[
{
"start":"allday",
"end":"23:59:00"
}
]
}
]
}
...
],
"count":3,
"total":3,
"links":{
"self":"/api/v1/teams?offset=0&limit=10"
}
}Update Team #
Updates a team.
PATCH
https://app.mycallassist.com/api/v1/teams/{teamId}Request
{
"id": "5f97641c3e575400179dc116",
"name": "Alpha Team",
"callMode": "round robin",
"whisperText": "Please press 1 to connect to {first}...",
"whisperLanguage": "en-US",
"recordCall": true,
"delay": 5,
"callback_url": "http://webhookurl.com/s8f8fsfsid7f",
"optOut": false,
"members": [
{
"id": "160637174875251747683"
"first": "John",
"last": "Helloman",
"phone": "15555555555"
}
],
"hasSchedule": true,
"timezone": "America/Vancouver",
"schedule": [
{
"label": "Sunday",
"day": 0,
"is_available": true,
"times": [
{
"start": "09:00:00",
"end": "16:00:00"
}
]
},
{
"label": "Monday",
"day": 1,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Tuesday",
"day": 2,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Wednesday",
"day": 3,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Thursday",
"day": 4,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Friday",
"day": 5,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Saturday",
"day": 6,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
}
],
}Create Team #
Creates a team.
POST
https://app.mycallassist.com/api/v1/team
Request
{
"id": "5f97641c3e575400179dc116",
"name": "Alpha Team",
"callMode": "round robin",
"whisperText": "Please press 1 to connect to {first}...",
"whisperLanguage": "en-US",
"recordCall": true,
"delay": 5,
"callback_url": "http://webhookurl.com/s8f8fsfsid7f",
"optOut": false,
"members": [
{
"id": "160637174875251747683"
"first": "John",
"last": "Helloman",
"phone": "15555555555"
}
],
"hasSchedule": true,
"timezone": "America/Vancouver",
"schedule": [
{
"label": "Sunday",
"day": 0,
"is_available": true,
"times": [
{
"start": "09:00:00",
"end": "16:00:00"
}
]
},
{
"label": "Monday",
"day": 1,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Tuesday",
"day": 2,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Wednesday",
"day": 3,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Thursday",
"day": 4,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Friday",
"day": 5,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
},
{
"label": "Saturday",
"day": 6,
"is_available": true,
"times": [
{
"start": "allday",
"end": "23:59:00"
}
]
}
],
}