Agents

Get an Agent #

Returns an agent object.

GET

https://app.mycallassist.com/api/v1/agents/{agentId}

Response

{
  "id": "5f94a83ad5de1e0017fe6950",
  "account_id": "",
  "first": "John",
  "last": "Smith",
  "country": "ca",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "timezone": "America/Vancouver",
  "dnd": false,
  "is_available": true
}

Get Agents #

Returns a list of agent objects.

GET

https://app.mycallassist.com/api/v1/agents

Response

{
    "data": [
        {
            "id": "5f94a83ad5de1e0017fe6950",
            "account_id": "123",
            "first": "John",
            "last": "Smith",
            "country": "ca",
            "national": "15555555555",
            "email": "jsmith@example.com",
            "dnd": false,
            "timezone": "America/Vancouver",
            "is_available": true
        },
      ...
    ],
    "count": 3,
    "total": 3,
    "links": {
        "self": "/api/v1/agents?offset=0&limit=10"
    }
}

Get Agent Schedule #

Returns an agents schedule object.

GET

https://app.mycallassist.com/api/v1/agents/{agentId}/schedule

Response

[
    {
        "label": "Sunday",
        "day": 0,
        "is_available": true,
        "times": [
            {
                "start": "allday",
                "end": "23:59: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"
            }
        ]
    }
]

Update Agent #

Updates an agent.

PATCH

https://app.mycallassist.com/api/v1/agents/{agentId}

Request

{
  "first": "John",
  "last": "Smith",
  "country": "ca",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "dnd": true,
  "timezone": "America/Vancouver",
}


Update Agent Schedule #

Updates an agents schedule.

PATCH

https://app.mycallassist.com/api/v1/agents/{agentId}/schedule

Request

[
    {
        "label": "Sunday",
        "day": 0,
        "is_available": true,
        "times": [
            {
                "start": "09:00:00",
                "end": "16:00:00"
            }
        ]
    },
    {
        "label": "Monday",
        "day": 1,
        "is_available": false,
        "times": [

         ]
    },
    {
        "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 Agent #

Creates an agent.

POST

https://app.mycallassist.com/api/v1/agents

Request

{
  "first": "John",
  "last": "Smith",
  "country": "ca",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "dnd": true,
  "timezone": "America/Vancouver"
}

Delete an Agent #

Deletes an agent.

You cannot delete an account owner.

DELETE

https://app.mycallassist.com/api/v1/agents/{agentId}

Request

{
  "response": "success"
}