API Documentation

Welcome to the API documentation. Here you can find all the details about our API methods, error codes, and more.

Required Headers

Header Value Description

Mumble-Api-Key

<TOKEN>

Your API token for authentication. Find your token in your account technical settings.

Content-Type

application/json

Indicates that the request body format is JSON.

API Methods

POSThttps://app.mumble.co.il/mumbleapi/add-new-customer

Add a new customer.

Request Example
{"adset_id": "123", "bot_token": "example-bot-token", "campaign_id": "campaign_123456", "cid": "cid_123456", "current_url": "http://example.com", "customer_phone": "1234567890", "device": "desktop", "email": "[email protected]", "fbc": "fbc_123456", "fbclid": "fbclid_123456", "fbp": "fbp_123456", "form": "form_1", "ga_id": "GA-123456", "ga_session_id": "session_123456", "gbraid": "gbraid_123456", "gclid": "gclid_123456", "ip": "192.168.1.1", "keyword_id": "keyword_123456", "layer": "layer_1", "li_fat_id": "li_fat_id_123456", "matchtype": "broad", "msclickid": "msclickid_123456", "name": "John Doe", "network": "network_1", "obcid": "obcid_123456", "placement": "top_banner", "source": "web", "tblci": "tblci_123456", "ttcid": "ttcid_123456", "twclid": "twclid_123456", "user_agent": "Mozilla/5.0", "utm_campaign": "summer_sale", "utm_content": "ad_content", "utm_medium": "cpc", "utm_source": "google", "utm_term": "keyword", "wbraid": "wbraid_123456", "yclid": "yclid_123456"}
Request Parameters
Name Type Required

customer_phone

string

Yes

name

string

No

email

string

No

source

string

No

bot_token

string

No

utm_source

string

No

utm_medium

string

No

utm_campaign

string

No

utm_content

string

No

utm_term

string

No

placement

string

No

adset_id

string

No

ga_id

string

No

ga_session_id

string

No

campaign_id

string

No

keyword_id

string

No

gclid

string

No

wbraid

string

No

gbraid

string

No

fbclid

string

No

msclickid

string

No

ttcid

string

No

yclid

string

No

obcid

string

No

li_fat_id

string

No

tblci

string

No

twclid

string

No

current_url

string

No

user_agent

string

No

ip

string

No

fbc

string

No

fbp

string

No

cid

string

No

matchtype

string

No

device

string

No

layer

string

No

network

string

No

form

string

No
Error Codes
Code Message
200 {"message": "added successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to add customer due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/edit-customer

Edit an existing customer.

Request Example
{"adset_id": "123", "bot_token": "example-bot-token", "campaign_id": "campaign_123456", "cid": "cid_123456", "current_url": "http://example.com", "customer_phone": "1234567890", "device": "desktop", "email": "[email protected]", "fbc": "fbc_123456", "fbclid": "fbclid_123456", "fbp": "fbp_123456", "form": "form_1", "ga_id": "GA-123456", "ga_session_id": "session_123456", "gbraid": "gbraid_123456", "gclid": "gclid_123456", "ip": "192.168.1.1", "keyword_id": "keyword_123456", "layer": "layer_1", "li_fat_id": "li_fat_id_123456", "matchtype": "broad", "msclickid": "msclickid_123456", "name": "John Doe", "network": "network_1", "obcid": "obcid_123456", "placement": "top_banner", "source": "web", "tblci": "tblci_123456", "ttcid": "ttcid_123456", "twclid": "twclid_123456", "user_agent": "Mozilla/5.0", "utm_campaign": "summer_sale", "utm_content": "ad_content", "utm_medium": "cpc", "utm_source": "google", "utm_term": "keyword", "wbraid": "wbraid_123456", "yclid": "yclid_123456"}
Request Parameters
Name Type Required

customer_phone

string

Yes

name

string

No

email

string

No

source

string

No

bot_token

string

No

utm_source

string

No

utm_medium

string

No

utm_campaign

string

No

utm_content

string

No

utm_term

string

No

placement

string

No

adset_id

string

No

ga_id

string

No

ga_session_id

string

No

campaign_id

string

No

keyword_id

string

No

gclid

string

No

wbraid

string

No

gbraid

string

No

fbclid

string

No

msclickid

string

No

ttcid

string

No

yclid

string

No

obcid

string

No

li_fat_id

string

No

tblci

string

No

twclid

string

No

current_url

string

No

user_agent

string

No

ip

string

No

fbc

string

No

fbp

string

No

cid

string

No

matchtype

string

No

device

string

No

layer

string

No

network

string

No

form

string

No
Error Codes
Code Message
200 {"message": "added successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to add customer due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/delete-customer

Delete an existing customer.

Request Example
{"customer_phone": "1234567890"}
Request Parameters
Name Type Required

customer_phone

string

Yes
Error Codes
Code Message
200 {"message": "deleted successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to delete customer due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/add-customer-to-label

Add a customer to a label.

Request Example
{"customer_phone": "1234567890", "label_name": "example_label"}
Request Parameters
Name Type Required

customer_phone

string

Yes

label_name

string

Yes
Error Codes
Code Message
200 {"message": "added successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Label name is required."}
400 {"error": true, "message": "Failed to add customer to label due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
404 {"error": true, "message": "Label not found"}
500 {"error": true, "message": "An unexpected error occurred"}

DELETEhttps://app.mumble.co.il/mumbleapi/remove-customer-from-label

Remove a customer from a label.

Request Example
{"customer_phone": "1234567890", "label_name": "example_label"}
Request Parameters
Name Type Required

customer_phone

string

Yes

label_name

string

Yes
Error Codes
Code Message
200 {"message": "removed successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Label name is required."}
400 {"error": true, "message": "Failed to remove customer from label due to invalid input"}
400 {"error": true, "message": "Customer is not in the label"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
404 {"error": true, "message": "Label not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/get-customer

Get customer information.

Request Example
{"customer_phone": "1234567890"}
Request Parameters
Name Type Required

customer_phone

string

Yes
Error Codes
Code Message
200 {"customer": {"email": "[email protected]", "name": "John Doe", "phone": "1234567890"}, "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to get customer due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/get-all-customers

Get all customers with pagination.

Request Example
{"page": 1}
Request Parameters
Name Type Required

page

int

No
Error Codes
Code Message
200 {"current_page": 1, "customers": [], "pages": 2, "per_page": 250, "success": true, "total": 250, "total_pages": 2}
400 {"error": true, "message": "Failed to get customers due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/get-convresation

Get conversation of a customer.

Request Example
{"customer_phone": "1234567890"}
Request Parameters
Name Type Required

customer_phone

string

Yes
Error Codes
Code Message
200 {"current_page": 1, "messages": [{"from": "123456789", "id": 1, "is_audio": false, "is_geo_location": false, "is_img": false, "is_pdf": false, "is_sticker": false, "is_video": false, "media_url": "https://example.com", "text": "Hello", "timestamp": 1630000000, "to": "987654321"}], "pages": 1, "success": true, "total": 1}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to get conversation due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/add-new-label

Add a new label.

Request Example
{"label_name": "example_label"}
Request Parameters
Name Type Required

label_name

string

Yes
Error Codes
Code Message
200 {"message": "Label \u0027\u003clabel_name\u003e\u0027 created successfully", "success": true}
400 {"error": true, "message": "Label name is required."}
400 {"error": true, "message": "Failed to add label due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}

DELETEhttps://app.mumble.co.il/mumbleapi/delete-label

Delete a label.

Request Example
{"label_name": "example_label"}
Request Parameters
Name Type Required

label_name

string

Yes
Error Codes
Code Message
200 {"message": "Label \u0027\u003clabel_name\u003e\u0027 deleted successfully", "success": true}
400 {"error": true, "message": "Label name is required."}
400 {"error": true, "message": "Failed to delete label due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Label not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/get-labels

Get all labels.

Request Example
{}
Request Parameters
Name Type Required
Error Codes
Code Message
200 {"labels": [], "success": true}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/send-template

Send a template message to a customer.

Request Example
{"bot_token": "example-bot-token", "customer_phone": "123456789", "email": "[email protected]", "media_link": "https://example.com", "name": "John Doe", "source": "web", "template_id": "123"}
Request Parameters
Name Type Required

customer_phone

string

Yes

template_id

string

Yes

source

string

No

bot_token

string

No

name

string

No

email

string

No

media_link

string

No
Error Codes
Code Message
200 {"message": "Template message sent successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Template ID is required."}
400 {"error": true, "message": "Failed to send template message due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GEThttps://app.mumble.co.il/mumbleapi/is-active-conv

Check if a conversation is active.

Request Example
{"customer_phone": "1234567890"}
Request Parameters
Name Type Required

customer_phone

string

Yes
Error Codes
Code Message
200 {"is_active": true, "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Failed to check conversation status due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/send-template-text-variable

Send a template message with text variables to a customer.

Request Example
{"bot_token": "example-bot-token", "customer_phone": "123456789", "email": "[email protected]", "name": "John Doe", "source": "web", "template_id": "123", "variable": ["variable1", "variable2"]}
Request Parameters
Name Type Required

GEThttps://app.mumble.co.il/mumbleapi/get-templates

Get all templates.

Request Example
{}
Request Parameters
Name Type Required
Error Codes
Code Message
200 {"success": true, "templates": []}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}

POSThttps://app.mumble.co.il/mumbleapi/send-text-message

Send a text message to a customer.

Request Example
{"bot_token": "example-bot-token", "customer_phone": "123456789", "email": "[email protected]", "name": "John Doe", "source": "web", "text": "Hello"}
Request Parameters
Name Type Required

customer_phone

string

Yes

text

string

Yes

source

string

No

bot_token

string

No

name

string

No

email

string

No
Error Codes
Code Message
200 {"message": "Text message sent successfully", "success": true}
400 {"error": true, "message": "Phone number is required."}
400 {"error": true, "message": "Text is required."}
400 {"error": true, "message": "Failed to send text message due to invalid input"}
401 {"error": true, "message": "Unauthorized"}
404 {"error": true, "message": "Customer not found"}
500 {"error": true, "message": "An unexpected error occurred"}

GET/mumbleapi/get-bots

Get all bots.

Request Example
{}
Request Parameters
Name Type Required
Error Codes
Code Message
200 {"bots": [], "success": true}
401 {"error": true, "message": "Unauthorized"}
500 {"error": true, "message": "An unexpected error occurred"}