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": 2833, "allowed_countries": "value", "button_id": 6405, "created_at": "2021-06-22 18:24:44", "culture": 3, "ddi": 4197, "floating_icon": true, "max_call_rate": 2.2, "name": "value", "position": 6, "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": 3911, "allowed_countries": "value", "button_id": 9468, "created_at": "2022-07-22 23:10:17", "culture": 4, "ddi": 6437, "floating_icon": true, "max_call_rate": 8.17, "name": "value", "position": 1, "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": 624, "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": 184, "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": 4536, "allowed_countries": "value", "button_id": 3419, "created_at": "2023-06-16 03:03:13", "culture": 4, "ddi": 2179, "floating_icon": true, "max_call_rate": 3.2, "name": "value", "position": 4, "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/34 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": 5105, "allowed_countries": "value", "button_id": 7495, "created_at": "2022-05-22 15:53:31", "culture": 0, "ddi": 6314, "floating_icon": true, "max_call_rate": 5.14, "name": "value", "position": 5, "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/82 HTTP/1.1 Host: l7api.com { "button_id": 997, "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": 739, "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": 9248, "allowed_countries": "value", "button_id": 7391, "created_at": "2024-06-02 23:21:30", "culture": 4, "ddi": 133, "floating_icon": true, "max_call_rate": 7.14, "name": "value", "position": 7, "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/44 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": 3038, "allowed_countries": "value", "button_id": 6213, "created_at": "2018-04-24 03:09:15", "culture": 2, "ddi": 7698, "floating_icon": true, "max_call_rate": 4.14, "name": "value", "position": 1, "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": 5251, "allowed_countries": "value", "button_id": 1400, "created_at": "2024-09-06 09:41:44", "culture": 3, "ddi": 6239, "floating_icon": true, "max_call_rate": 8.25, "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/20 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": 5664, "allowed_countries": "value", "button_id": 4576, "created_at": "2024-12-09 14:44:18", "culture": 1, "ddi": 6104, "floating_icon": true, "max_call_rate": 5.2, "name": "value", "position": 1, "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/77 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": 5644, "allowed_countries": "value", "button_id": 7766, "created_at": "2022-02-14 22:06:11", "culture": 3, "ddi": 8273, "floating_icon": true, "max_call_rate": 6.1, "name": "value", "position": 0, "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/64 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": 3443, "allowed_countries": "value", "button_id": 6685, "created_at": "2016-06-21 09:33:37", "culture": 4, "ddi": 8841, "floating_icon": true, "max_call_rate": 5.14, "name": "value", "position": 6, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }