Agendize Developers API

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. Writable. Max length: 128.
phoneNumber string Destination number of the call tracking number. Writable
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. Writable
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 https://api.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 https://api.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 https://api.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:

{ items: [Call Tracking Resource] }

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 tracking number in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.0/calls/calltrackings/watch

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

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

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.