Call Me Back module
Endpoints
Endpoints for managing configuration for Call Me Back widgets, websites and buttons
GET
/callmeback/websites Returns collection of Campaign resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/callmeback/websites HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 8444, "allowed_countries": "value", "button_id": 1982, "created_at": "2017-07-01 23:02:39", "culture": 4, "ddi": 7436, "floating_icon": true, "max_call_rate": 7.33, "name": "value", "position": 3, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" } ], "total": 59 }
GET
/callmeback/settings Returns collection of Campaign resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/callmeback/settings HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 6393, "allowed_countries": "value", "button_id": 5418, "created_at": "2021-10-23 10:46:17", "culture": 0, "ddi": 7117, "floating_icon": true, "max_call_rate": 4.14, "name": "value", "position": 4, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" } ], "total": 59 }
POST
/callmeback/settings Creates new Call Me Back settings resource
Parameters
JSON body attributes:
button_id integer
name string
position string
floating_icon boolean
culture string
allowed_countries undefined
show_to_allowed_countries_only boolean
welcome_screen_msg string
privacy_policy_url string
ddi_e164 integer
max_call_rate float
Float value.
Float value.
Example Request
POST /v1.1/voipstudio/callmeback/settings HTTP/1.1 Host: l7api.com { "button_id": 578, "name": "abcd", "position": "abcd", "floating_icon": true, "culture": "abcd", "allowed_countries": "abcd", "show_to_allowed_countries_only": true, "welcome_screen_msg": "abcd", "privacy_policy_url": "abcd", "ddi_e164": 657, "max_call_rate": "100.00" }
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK Content-Type: application/json { "data": { "id": 5658, "allowed_countries": "value", "button_id": 8972, "created_at": "2024-02-09 14:31:03", "culture": 3, "ddi": 8977, "floating_icon": true, "max_call_rate": 6.5, "name": "value", "position": 6, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }
GET
/callmeback/settings/{id} Returns Website resource for given Id
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
Example Request
GET /v1.1/voipstudio/callmeback/settings/97 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 317, "allowed_countries": "value", "button_id": 4895, "created_at": "2022-10-09 05:53:08", "culture": 1, "ddi": 258, "floating_icon": true, "max_call_rate": 4.1, "name": "value", "position": 6, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }
PATCH
/callmeback/settings/{id} Updates existing CallMeBackSetting resource
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
JSON body attributes:
button_id integer
name string
position string
floating_icon boolean
culture string
allowed_countries undefined
show_to_allowed_countries_only boolean
welcome_screen_msg string
privacy_policy_url string
ddi_e164 integer
max_call_rate float
Float value.
Float value.
Example Request
PATCH /v1.1/voipstudio/callmeback/settings/81 HTTP/1.1 Host: l7api.com { "button_id": 320, "name": "abcd", "position": "abcd", "floating_icon": true, "culture": "abcd", "allowed_countries": "abcd", "show_to_allowed_countries_only": true, "welcome_screen_msg": "abcd", "privacy_policy_url": "abcd", "ddi_e164": 762, "max_call_rate": "100.00" }
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 9229, "allowed_countries": "value", "button_id": 8616, "created_at": "2017-11-10 01:54:32", "culture": 4, "ddi": 4583, "floating_icon": true, "max_call_rate": 7.13, "name": "value", "position": 5, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }
DELETE
/callmeback/settings/{id} Deletes existing resource
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
Example Request
DELETE /v1.1/voipstudio/callmeback/settings/89 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
401 Unauthorized
403 Access denied
Example Response
HTTP/1.1 204 OK
GET
/callmeback/cdrs Returns collection of Cdr resources assigned to CallMeBack
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/callmeback/cdrs HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 3749, "allowed_countries": "value", "button_id": 7699, "created_at": "2022-08-26 23:44:09", "culture": 3, "ddi": 1219, "floating_icon": true, "max_call_rate": 9.13, "name": "value", "position": 7, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" } ], "total": 59 }
GET
/callmeback/visitors Returns collection of Visitor resources assigned to CallMeBack
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/callmeback/visitors HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 7432, "allowed_countries": "value", "button_id": 4860, "created_at": "2020-02-15 19:11:56", "culture": 1, "ddi": 6199, "floating_icon": true, "max_call_rate": 4.2, "name": "value", "position": 3, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" } ], "total": 59 }
GET
/callmeback/buttons/{id} Returns CallMeBackButton resource for given Id
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
Example Request
GET /v1.1/voipstudio/callmeback/buttons/96 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 8777, "allowed_countries": "value", "button_id": 8944, "created_at": "2016-11-09 14:16:06", "culture": 3, "ddi": 5442, "floating_icon": true, "max_call_rate": 3.5, "name": "value", "position": 2, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }
PATCH
/callmeback/buttons/{id} Creates new Call Me Button resource
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
JSON body attributes:
name string
data_online string
data_offline string
Example Request
PATCH /v1.1/voipstudio/callmeback/buttons/96 HTTP/1.1 Host: l7api.com { "name": "abcd", "data_online": "abcd", "data_offline": "abcd" }
Responses
200 Success
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 6444, "allowed_countries": "value", "button_id": 2857, "created_at": "2020-01-08 04:12:48", "culture": 2, "ddi": 1065, "floating_icon": true, "max_call_rate": 5.5, "name": "value", "position": 2, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }
DELETE
/callmeback/buttons/{id} Deletes existing resource
Parameters
Endpoint URL:
{id} integerCallMeBackSetting identifier
Example Request
DELETE /v1.1/voipstudio/callmeback/buttons/68 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
401 Unauthorized
403 Access denied
Example Response
HTTP/1.1 204 OK
POST
/callmeback/buttons Creates new CallMeBackButton resource
Parameters
Example Request
POST /v1.1/voipstudio/callmeback/buttons HTTP/1.1 Host: l7api.com
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK Content-Type: application/json { "data": { "id": 6759, "allowed_countries": "value", "button_id": 1598, "created_at": "2020-08-17 05:33:15", "culture": 4, "ddi": 9130, "floating_icon": true, "max_call_rate": 6.14, "name": "value", "position": 4, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }