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": 9810, "allowed_countries": "value", "button_id": 6832, "created_at": "2017-08-25 12:36:07", "culture": 0, "ddi": 3030, "floating_icon": true, "max_call_rate": 6.33, "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": 8173, "allowed_countries": "value", "button_id": 280, "created_at": "2018-05-15 07:00:29", "culture": 4, "ddi": 4793, "floating_icon": true, "max_call_rate": 5.2, "name": "value", "position": 5, "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": 958, "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": 165, "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": 8649, "allowed_countries": "value", "button_id": 304, "created_at": "2016-10-02 00:34:23", "culture": 3, "ddi": 9672, "floating_icon": true, "max_call_rate": 8.11, "name": "value", "position": 1, "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/66 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": 1433, "allowed_countries": "value", "button_id": 1005, "created_at": "2021-08-01 13:36:45", "culture": 4, "ddi": 5000, "floating_icon": true, "max_call_rate": 8.11, "name": "value", "position": 0, "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/7 HTTP/1.1 Host: l7api.com { "button_id": 202, "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": 118, "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": 2544, "allowed_countries": "value", "button_id": 9182, "created_at": "2024-03-20 07:48:41", "culture": 3, "ddi": 4307, "floating_icon": true, "max_call_rate": 4.17, "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/92 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": 3301, "allowed_countries": "value", "button_id": 3924, "created_at": "2018-01-25 06:21:36", "culture": 0, "ddi": 7899, "floating_icon": true, "max_call_rate": 4.25, "name": "value", "position": 4, "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": 841, "allowed_countries": "value", "button_id": 4929, "created_at": "2024-10-23 06:44:37", "culture": 4, "ddi": 5193, "floating_icon": true, "max_call_rate": 7.11, "name": "value", "position": 2, "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/72 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": 8697, "allowed_countries": "value", "button_id": 4761, "created_at": "2022-10-18 16:12:05", "culture": 2, "ddi": 6066, "floating_icon": true, "max_call_rate": 7.1, "name": "value", "position": 4, "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/12 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": 3452, "allowed_countries": "value", "button_id": 5628, "created_at": "2016-07-14 06:47:00", "culture": 1, "ddi": 4486, "floating_icon": true, "max_call_rate": 5.13, "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/90 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": 6, "allowed_countries": "value", "button_id": 2766, "created_at": "2016-10-12 03:04:04", "culture": 4, "ddi": 9974, "floating_icon": true, "max_call_rate": 2.25, "name": "value", "position": 3, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }