All URIs are relative to https://www.dadapush.com
Method | HTTP request | Description |
---|---|---|
createMessage | POST /api/v1/message | push Message to a Channel |
deleteMessage | DELETE /api/v1/message/{messageId} | delete a Channel Message |
getMessage | GET /api/v1/message/{messageId} | get a Channel Message |
getMessages | GET /api/v1/messages | get Message List |
\DaDaPushClient\Model\ResultOfMessagePushResponse createMessage($body, $x_channel_token)
push Message to a Channel
- 1 request per 1s
- 30 request per 1m
- 500 request per 1h
- 0: ok
- 1: server error
- 101: channel is exists
- 102: channel is not exists
- 103: channel token error
- 104: channel is not exists
- 105: message is not exists
- 204: bad request
- 205: permission deny
- 206: too many request, please after 5 minutes to try!
- 301: duplicate username/email
- 302: user is not exists
- 303: user password is error
- 304: client push token is error
- 305: user is disabled
- 306: your subscription is expired
- 307: user not subscribe channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DaDaPushClient\Api\DaDaPushMessageApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$body = new \DaDaPushClient\Model\MessagePushRequest(); // \DaDaPushClient\Model\MessagePushRequest | body
$x_channel_token = 'x_channel_token_example'; // string | see: https://www.dadapush.com/channel/list
try {
$result = $apiInstance->createMessage($body, $x_channel_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DaDaPushMessageApi->createMessage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \DaDaPushClient\Model\MessagePushRequest | body | |
x_channel_token | string | see: https://www.dadapush.com/channel/list | [optional] |
\DaDaPushClient\Model\ResultOfMessagePushResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DaDaPushClient\Model\Result deleteMessage($message_id, $x_channel_token)
delete a Channel Message
- 10 request per 1s
- 100 request per 1m
- 1000 request per 1h
- 0: ok
- 1: server error
- 101: channel is exists
- 102: channel is not exists
- 103: channel token error
- 104: channel is not exists
- 105: message is not exists
- 204: bad request
- 205: permission deny
- 206: too many request, please after 5 minutes to try!
- 301: duplicate username/email
- 302: user is not exists
- 303: user password is error
- 304: client push token is error
- 305: user is disabled
- 306: your subscription is expired
- 307: user not subscribe channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DaDaPushClient\Api\DaDaPushMessageApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$message_id = 56; // int | messageId
$x_channel_token = 'x_channel_token_example'; // string | see: https://www.dadapush.com/channel/list
try {
$result = $apiInstance->deleteMessage($message_id, $x_channel_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DaDaPushMessageApi->deleteMessage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
message_id | int | messageId | |
x_channel_token | string | see: https://www.dadapush.com/channel/list | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DaDaPushClient\Model\ResultOfMessageObject getMessage($message_id, $x_channel_token)
get a Channel Message
- 10 request per 1s
- 100 request per 1m
- 1000 request per 1h
- 0: ok
- 1: server error
- 101: channel is exists
- 102: channel is not exists
- 103: channel token error
- 104: channel is not exists
- 105: message is not exists
- 204: bad request
- 205: permission deny
- 206: too many request, please after 5 minutes to try!
- 301: duplicate username/email
- 302: user is not exists
- 303: user password is error
- 304: client push token is error
- 305: user is disabled
- 306: your subscription is expired
- 307: user not subscribe channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DaDaPushClient\Api\DaDaPushMessageApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$message_id = 56; // int | messageId
$x_channel_token = 'x_channel_token_example'; // string | see: https://www.dadapush.com/channel/list
try {
$result = $apiInstance->getMessage($message_id, $x_channel_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DaDaPushMessageApi->getMessage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
message_id | int | messageId | |
x_channel_token | string | see: https://www.dadapush.com/channel/list | [optional] |
\DaDaPushClient\Model\ResultOfMessageObject
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DaDaPushClient\Model\ResultOfPageResponseOfMessageObject getMessages($page, $page_size, $x_channel_token)
get Message List
- 1 request per 1s
- 45 request per 1m
- 0: ok
- 1: server error
- 101: channel is exists
- 102: channel is not exists
- 103: channel token error
- 104: channel is not exists
- 105: message is not exists
- 204: bad request
- 205: permission deny
- 206: too many request, please after 5 minutes to try!
- 301: duplicate username/email
- 302: user is not exists
- 303: user password is error
- 304: client push token is error
- 305: user is disabled
- 306: your subscription is expired
- 307: user not subscribe channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DaDaPushClient\Api\DaDaPushMessageApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$page = 1; // int | greater than 1
$page_size = 10; // int | range is 1,50
$x_channel_token = 'x_channel_token_example'; // string | see: https://www.dadapush.com/channel/list
try {
$result = $apiInstance->getMessages($page, $page_size, $x_channel_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DaDaPushMessageApi->getMessages: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
page | int | greater than 1 | [default to 1] |
page_size | int | range is 1,50 | [default to 10] |
x_channel_token | string | see: https://www.dadapush.com/channel/list | [optional] |
\DaDaPushClient\Model\ResultOfPageResponseOfMessageObject
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]