Agendize Calls API

Call Tracking Numbers


Resource representation

{ "id": {string}, "name": {string}, "phoneNumber": {string}, "trackingPhoneNumber": {string}, "owner":{ "id": {string), "userName": {string} } }
Parameter name Value Description
id string Identifier of the click-to-call button. Read-only
name string Name of the call tracking number.
phoneNumber string Destination number of the call tracking number
trackingPhoneNumber string Call tracking number. Read-only
owner string Owner account of the chat button and session.
owner.id string Identifier of the owner account.
owner.userName string user name of the owner account.

Delete

Deletes an entry on the click-to-call button list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/calls/calltrackings/{callTrackingId}

Parameters

Parameter name Value Description
Path parameters
callTrackingId string Call Tracking identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the Call Tracking list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/calls/calltrackings/{callTrackingId}

Parameters

Parameter name Value Description
Path parameters
callTrackingId string Call Tracking identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Call Tracking resource in the response body.


List

Returns entries on the Call Tracking list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/calls/calltrackings

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:


Watch

Watch for changes to Call resources.

Authentication is required to execute this request. Please refer to Authentication for more.

The watch send an Call resource in the request body

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/calls/calltrackings/watch

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Parameters

companyId string Company identifier.

Request body

{ "id": {string}, "address": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} } }
id string Identifier of the watch.
address string The address where notifications are delivered for this watch.
basicAuth string Credentials parameters for HTTP Basic authentication. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Username.
httpRequestHeader string Custom header parameters to send with the http request.
httpRequestHeader.name string header parameter name.

Response

If successful, this method returns an of Watch resource in the response body.