Wstęp
Pobierz z Google Play
Zarejestruj się
Wygeneruj klucz dostępu w tej zakładce.
Aktualne, gotowe biblioteki znajdziesz na GitHubie.
Zapoznaj się z poniższą dokumentacją oraz FAQ.
Wyślij wiadomość pod numer
API Endpoint | |||
---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages/send | ||
Method: | POST | ||
Data type: | JSON | ||
Request Parameters | |||
Parameter | Required | Type | Description |
token | YES | String | Your API token |
number | YES | String | The number to send the message to |
message | YES | String | The content of the message to be sent |
device | YES | Number | The ID of device you wish to send the message from |
send_at | NO | Number | Time to send the message in Unix Time format (e.g. 1734804452) |
Success Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example | ||
Failed Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $number = '+48123456789';
-
- $message = 'Hello World!';
-
- $device = 9;
-
- $options = [
-
-
- 'send_at' => strtotime('+30 minutes') // Send the message in 30 minutes
-
-
- ];
-
- $result = $bulkSms->sendMessageToNumber($number, $message, $device, $options);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Wyślij wiadomość do wielu numerów
API Endpoint | |||
---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages/send | ||
Method: | POST | ||
Data type: | JSON | ||
Request Parameters | |||
Parameter | Required | Type | Description |
token | YES | String | Your API token |
number | YES | String[ ] | An array containing the numbers the message is to be sent to |
message | YES | String | The content of the message to be sent |
device | YES | Number | The ID of device you wish to send the message from |
send_at | NO | Number | Time to send the message in Unix Time format (e.g. 1734804452) |
Success Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example | ||
Failed Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $number = ['+48123456789', '+48987654321'];
-
- $message = 'Hello World!';
-
- $device = 6;
-
- $options = [
-
-
- 'send_at' => strtotime('+30 minutes') // Send the message in 30 minutes
-
-
- ];
-
- $result = $bulkSms->sendMessageToManyNumbers($number, $message, $device, $options);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Wyślij wiadomość do kontaktu
API Endpoint | |||
---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages/send | ||
Method: | POST | ||
Data type: | JSON | ||
Request Parameters | |||
Parameter | Required | Type | Description |
token | YES | String | Your API token |
contact | YES | Number | The contact ID to send the message to |
message | YES | String | The content of the message to be sent |
device | YES | Number | The ID of device you wish to send the message from |
send_at | NO | Number | Time to send the message in Unix Time format (e.g. 1734804452) |
Success Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example | ||
Failed Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $contact = 6;
-
- $message = 'Hello World!';
-
- $device = 5;
-
- $options = [
-
-
- 'send_at' => strtotime('+30 minutes') // Send the message in 30 minutes
-
-
- ];
-
- $result = $bulkSms->sendMessageToContact($contact, $message, $device, $options);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Wyślij wiadomość do wielu kontaktów
API Endpoint | |||
---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages/send | ||
Method: | POST | ||
Data type: | JSON | ||
Request Parameters | |||
Parameter | Required | Type | Description |
token | YES | String | Your API token |
contact | YES | Number[ ] | An array containing the contacts the message is to be sent to |
message | YES | String | The content of the message to be sent |
device | YES | Number | The ID of device you wish to send the message from |
send_at | NO | Number | Time to send the message in Unix Time format (e.g. 1734804452) |
Success Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example | ||
Failed Response | |||
Status Code: | 200 OK | ||
Content Type: | application/json | ||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $contact = [1, 7];
-
- $message = 'Hello World!';
-
- $device = 7;
-
- $options = [
-
-
- 'send_at' => strtotime('+30 minutes') // Send the message in 30 minutes
-
-
- ];
-
- $result = $bulkSms->sendMessageToManyContacts($contact, $message, $device, $options);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Lista wiadomości
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | Default |
token | YES | String | Your API token | |
page | NO | Number | The page number (500 results per page) | 1 |
type | NO | String |
Possible options:
• 'sent' • 'received' |
NULL |
contact | NO | Number | ID of the contact | NULL |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $page = 2;
-
- $options = [
-
-
- 'type' => 'received', // or 'sent'. Define only if you want to download sent or received SMS separately
-
-
-
- 'contact' => 45 // Define only if you want to download a conversation with 1 contact
-
-
- ];
-
- $result = $bulkSms->getMessages($page, $options);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Pobierz jedną wiadomość
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/messages/view | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | |
token | YES | String | Your API token | |
id | YES | Number | ID of the message | |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $id = 9;
-
- $result = $bulkSms->getMessage($id);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Lista kontaktów
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/contacts | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | Default |
token | YES | String | Your API token | |
page | NO | Number | The page number (500 results per page) | 1 |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $page = 1;
-
- $result = $bulkSms->getContacts($page);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Pobierz jedną wiadomość
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/contacts/view | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | |
token | YES | String | Your API token | |
id | YES | Number | ID of the contact | |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $id = 7;
-
- $result = $bulkSms->getContact($id);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Lista urządzeń
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/devices | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | Default |
token | YES | String | Your API token | |
page | NO | Number | The page number (500 results per page) | 1 |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $page = 2;
-
- $result = $bulkSms->getDevices($page);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.
Pobierz jedno urządzenie
API Endpoint | ||||
---|---|---|---|---|
URL: | https://codejungle.pl/bulk-sms/api/devices/view | |||
Method: | GET | |||
Data type: | JSON | |||
Request Parameters | ||||
Parameter | Required | Type | Description | |
token | YES | String | Your API token | |
id | YES | Number | ID of the device | |
Success Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example | |||
Failed Response | ||||
Status Code: | 200 OK | |||
Content Type: | application/json | |||
Output format: | See example |
- <?php
-
- include 'bulkSms.php';
-
- $bulkSms = new bulkSms('token');
-
- $id = 8;
-
- $result = $bulkSms->getDevice($id);
- ?>
Success Example:
- // We're working on it.
Error Example:
- // We're working on it.