Agendize Calls API

Click-to-Call Buttons


Resource representation

{ "id": {string}, "name": {string}, "phoneNumber": {string}, "countries": [{string}], "openingHours": [ { "day": "monday", "hours": [ { "start": {string}, "end": {string} } ] } ], "openingHoursEnabled": {boolean}, "maxDuration": {integer} }
Parameter name Value Description
id string Identifier of the click-to-call button. Read-only
name string Name of the click-to-call button.
phoneNumber string Destination number of the click-to-call button.
countries list Authorized country list of caller. Uppercase Alpha-2 codes of ISO-3166-1 standard.
openingHours list Opening hours of the click-to-call button.
openingHoursEnabled boolean Sets if the opening hours are enabled.
maxDuration boolean Maximum duration of a call, in minutes.

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/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Click-to-Call button 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 click-to-call button 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/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Call identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Click-to-Call button resource in the response body.


List

Returns entries on the click-to-call button 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/buttons

Request body

Do not supply a request body with this method.

Response

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


Insert

Adds an entry to the click-to-call button list.

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/calls/buttons

Request body

In the request body, supply a Click-to-Call button resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the click-to-call button.
phoneNumber string Destination number of the click-to-call button.

Response

If successful, this method returns a Click-to-Call button resource in the response body.


Update

Updates 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

PUT http://az2.agendize.com/api/2.0/calls/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Click-to-Call button identifier.

Request body

In the request body, supply a Click-to-Call button resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the click-to-call button.
phoneNumber string Destination number of the click-to-call button.
countries list Authorized country list of caller. Uppercase Alpha-2 codes of ISO-3166-1 standard.

Response

If successful, this method returns a Click-to-Call button resource in the response body.