Agents

List Agents

Endpoint

GET https://api.callingly.com/v1/agents?account_id=1

Sample Response

[
    {
        "id": 123,
        "account_id": 1,
        "fname": "John",
        "lname": "Smith",
        "phone_number": "+16024819661",
        "ext": "",
        "donotdisturb": 0,
        "priority": 1,
        "timezone": "America/Phoenix",
        "is_available": true
    }
]

Get Agent Schedule

Endpoint

GET https://api.callingly.com/v1/agents/{{id}}/schedule

Sample Response

[
    {
        "label": "Sunday",
        "day": 0,
        "is_available": false,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Monday",
        "day": 1,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Tuesday",
        "day": 2,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "12:00:00"
            },
            {
                "start": "12:00:00",
                "end": "23:45:00"
            }
        ]
    },
    {
        "label": "Wednesday",
        "day": 3,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Thursday",
        "day": 4,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "22:00:00"
            }
        ]
    },
    {
        "label": "Friday",
        "day": 5,
        "is_available": true,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Saturday",
        "day": 6,
        "is_available": true,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    }
]

Create Agent

Endpoint

POST https://api.callingly.com/v1/agents

Sample Request

{
	"account_id": 1,
	"fname": "John",
        "lname": "Smith",
	"phone_number": "555-555-5555",
	"ext": "100",
	"timezone: "America/Phoenix"
}

Update Agent

Endpoint

PUT https://api.callingly.com/v1/agents/{{id}}

Sample Request

{
	"account_id": 1,
	"fname": "John",
        "lname": "Smith",
	"phone_number": "555-555-5555",
	"ext": "100",
	"timezone: "America/Phoenix",
	"donotdisturb": 1,
        "donotdisturb_until" "2021-01-25 22:00:00"
}

Delete Agent

Endpoint

DELETE https://api.callingly.com/v1/agents/{{id}}

Update Schedule

Endpoint

PUT https://api.callingly.com/v1/agents/{{id}}/schedule

Sample Request

[
    {
        "label": "Sunday",
        "day": 0,
        "is_available": false,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Monday",
        "day": 1,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Tuesday",
        "day": 2,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "12:00:00"
            },
            {
                "start": "12:00:00",
                "end": "23:45:00"
            }
        ]
    },
    {
        "label": "Wednesday",
        "day": 3,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Thursday",
        "day": 4,
        "is_available": true,
        "times": [
            {
                "start": "06:00:00",
                "end": "22:00:00"
            }
        ]
    },
    {
        "label": "Friday",
        "day": 5,
        "is_available": true,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    },
    {
        "label": "Saturday",
        "day": 6,
        "is_available": true,
        "times": [
            {
                "start": "allday",
                "end": "20:00:00"
            }
        ]
    }
]