Welcome to the QuickFlow Developer API documentation. You can use our REST API to manage contacts, contact groups, and send SMS messages seamlessly.
All API requests should be made to the following base URL:
http://127.0.0.1:8017/api/methodWe use token-based authentication. You must include your API Key and API Secret in the headers of all your requests. Pass them in the Authorization header using the format token api_key:api_secret.
Endpoints are constructed by appending the method path to the <baseurl>. For example, to send an SMS, the endpoint is http://127.0.0.1:8017/api/method/quickflow.sms.send.
Example cURL Request:
curl -X POST http://127.0.0.1:8017/api/method/quickflow.sms.send \
-H "Authorization: token your_api_key:your_api_secret" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"recipient": "254700000000",
"sender_id": "YOUR_SENDER_ID",
"message": "Hello from QuickFlow!"
}'Endpoints for sending SMS messages, managing campaigns, and checking credit balance.
/quickflow.sms.sendSend a single or bulk SMS to specific phone numbers.
recipient (string, required) - Phone number(s) separated by comma.sender_id (string, required) - Your assigned Sender ID.message (string, required) - The text message to send.type (string, optional) - Type of message (default: "plain").schedule_time (string, optional) - Time to schedule message.dlt_template_id (string, optional) - DLT Template ID if applicable.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.sms.send
/quickflow.sms.campaignSend SMS to all contacts within a specific contact group.
contact_list_id (string, required) - ID of the contact group.sender_id (string, required) - Your assigned Sender ID.message (string, required) - The text message to send.type (string, optional) - Type of message (default: "plain").schedule_time (string, optional) - Time to schedule message.dlt_template_id (string, optional) - DLT Template ID if applicable.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.sms.campaign
/quickflow.sms.getRetrieve the status of a specific SMS message.
uid (string, required) - The unique ID of the SMS.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.sms.get
/quickflow.sms.list_allRetrieve a history of all sent SMS messages.
Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.sms.list_all
/quickflow.sms.balanceCheck your current credit balance for a specific Sender ID.
sender_id (string, required) - Your assigned Sender ID.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.sms.balance
Endpoints for managing individual contacts within contact groups.
/quickflow.contact.store_contactAdd a new contact to an existing contact group.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.phone (string, required) - The contact's phone number.first_name (string, optional) - Contact's first name.last_name (string, optional) - Contact's last name.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.store_contact
/quickflow.contact.search_contactRetrieve details of a specific contact.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.uid (string, required) - Unique ID of the contact.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.search_contact
/quickflow.contact.update_contactUpdate an existing contact's information.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.uid (string, required) - Unique ID of the contact.phone (string, optional) - New phone number.first_name (string, optional) - New first name.last_name (string, optional) - New last name.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.update_contact
/quickflow.contact.delete_contactDelete a contact from a group.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.uid (string, required) - Unique ID of the contact to delete.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.delete_contact
/quickflow.contact.all_contactsRetrieve all contacts within a specific group.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.all_contacts
Endpoints for creating and managing contact groups.
/quickflow.contact.store_groupCreate a new contact group for organizing your contacts.
sender_id (string, required) - Your assigned Sender ID.name (string, required) - Name of the new contact group.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.store_group
/quickflow.contact.show_groupRetrieve details of a specific contact group.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group to retrieve.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.show_group
/quickflow.contact.update_groupUpdate the name of an existing contact group.
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group.name (string, required) - New name for the group.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.update_group
/quickflow.contact.delete_groupDelete a contact group. (Ensure it contains no active dependencies if required by logic).
sender_id (string, required) - Your assigned Sender ID.group_id (string, required) - ID of the contact group to delete.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.delete_group
/quickflow.contact.all_groupsRetrieve all contact groups assigned to your Sender ID.
sender_id (string, required) - Your assigned Sender ID.Endpoint URL:
http://127.0.0.1:8017/api/method/quickflow.contact.all_groups