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": 416, "allowed_countries": "value", "call_me_back_button": 5158, "created_at": "2024-03-13 13:17:59", "culture": 2, "ddi": 8913, "floating_icon": true, "max_call_rate": 3.14, "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": 2124, "allowed_countries": "value", "call_me_back_button": 3192, "created_at": "2018-04-28 04:54:11", "culture": 0, "ddi": 4037, "floating_icon": true, "max_call_rate": 9.2, "name": "value", "position": 7, "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": 350, "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": 945, "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": 9538, "allowed_countries": "value", "call_me_back_button": 1594, "created_at": "2020-11-14 19:57:52", "culture": 2, "ddi": 1172, "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" }, "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/23 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": 3159, "allowed_countries": "value", "call_me_back_button": 8219, "created_at": "2021-11-03 14:44:54", "culture": 2, "ddi": 780, "floating_icon": true, "max_call_rate": 5.1, "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": 276, "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": 474, "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": 579, "allowed_countries": "value", "call_me_back_button": 7266, "created_at": "2020-08-30 22:09:36", "culture": 2, "ddi": 2352, "floating_icon": true, "max_call_rate": 4.17, "name": "value", "position": 0, "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/80 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": 4241, "allowed_countries": "value", "call_me_back_button": 464, "created_at": "2019-08-20 16:43:37", "culture": 4, "ddi": 349, "floating_icon": true, "max_call_rate": 5.2, "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": 8116, "allowed_countries": "value", "call_me_back_button": 4955, "created_at": "2024-09-16 22:22:44", "culture": 2, "ddi": 4974, "floating_icon": true, "max_call_rate": 2.1, "name": "value", "position": 6, "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/93 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": 2409, "allowed_countries": "value", "call_me_back_button": 1080, "created_at": "2022-05-27 02:43:10", "culture": 2, "ddi": 811, "floating_icon": true, "max_call_rate": 6.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/63 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": 4944, "allowed_countries": "value", "call_me_back_button": 7305, "created_at": "2018-03-28 04:04:13", "culture": 1, "ddi": 5748, "floating_icon": true, "max_call_rate": 2.5, "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/60 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": 68, "allowed_countries": "value", "call_me_back_button": 5969, "created_at": "2019-12-20 00:35:06", "culture": 4, "ddi": 6014, "floating_icon": true, "max_call_rate": 5.17, "name": "value", "position": 2, "privacy_policy_url": "value", "show_to_allowed_countries_only": true, "title": "value", "welcome_screen_msg": "value" }, "links": {} }