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": 6193, "allowed_countries": "value", "button_id": 2965, "created_at": "2022-05-02 11:33:47", "culture": 3, "ddi": 8444, "floating_icon": true, "max_call_rate": 3.1, "name": "value", "position": 4, "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": 2524, "allowed_countries": "value", "button_id": 1339, "created_at": "2023-03-31 10:25:54", "culture": 1, "ddi": 1867, "floating_icon": true, "max_call_rate": 3.2, "name": "value", "position": 0, "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": 637, "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": 682, "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": 243, "allowed_countries": "value", "button_id": 8965, "created_at": "2021-08-29 00:27:11", "culture": 3, "ddi": 2594, "floating_icon": true, "max_call_rate": 9.5, "name": "value", "position": 3, "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/17 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": 2469, "allowed_countries": "value", "button_id": 1918, "created_at": "2018-10-12 05:41:41", "culture": 1, "ddi": 3670, "floating_icon": true, "max_call_rate": 6.13, "name": "value", "position": 2, "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/72 HTTP/1.1 Host: l7api.com { "button_id": 577, "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": 933, "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": 1508, "allowed_countries": "value", "button_id": 333, "created_at": "2021-10-06 19:21:04", "culture": 3, "ddi": 2872, "floating_icon": true, "max_call_rate": 7.25, "name": "value", "position": 6, "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/19 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": 9970, "allowed_countries": "value", "button_id": 8809, "created_at": "2020-11-14 20:29:52", "culture": 1, "ddi": 6583, "floating_icon": true, "max_call_rate": 4.11, "name": "value", "position": 6, "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": 2794, "allowed_countries": "value", "button_id": 6548, "created_at": "2024-05-27 17:33:33", "culture": 0, "ddi": 909, "floating_icon": true, "max_call_rate": 4.17, "name": "value", "position": 7, "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/78 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": 101, "allowed_countries": "value", "button_id": 3914, "created_at": "2019-03-10 00:34:15", "culture": 0, "ddi": 8510, "floating_icon": true, "max_call_rate": 3.14, "name": "value", "position": 3, "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/46 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": 9054, "allowed_countries": "value", "button_id": 7726, "created_at": "2023-03-12 06:41:14", "culture": 2, "ddi": 8479, "floating_icon": true, "max_call_rate": 4.1, "name": "value", "position": 1, "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/10 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": 7164, "allowed_countries": "value", "button_id": 1554, "created_at": "2016-12-24 00:57:47", "culture": 3, "ddi": 1089, "floating_icon": true, "max_call_rate": 4.2, "name": "value", "position": 5, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }