Skip to content

Latest commit

 

History

History
211 lines (146 loc) · 8.87 KB

DaDaPushMessageApi.md

File metadata and controls

211 lines (146 loc) · 8.87 KB
Raw

DaDaPushClient::DaDaPushMessageApi

Load the API package

use DaDaPushClient::Object::DaDaPushMessageApi;

All URIs are relative to https://www.dadapush.com

Method HTTP request Description
create_message POST /api/v1/message push Message to a Channel
delete_message DELETE /api/v1/message/{messageId} delete a Channel Message
get_message GET /api/v1/message/{messageId} get a Channel Message
get_messages GET /api/v1/messages get Message List

create_message

ResultOfMessagePushResponse create_message(body => $body, x_channel_token => $x_channel_token)

push Message to a Channel

Rate Limit:

  • 1 request per 1s
  • 30 request per 1m
  • 500 request per 1h

Result code/errmsg List:

  • 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

Example

use Data::Dumper;
use DaDaPushClient::DaDaPushMessageApi;
my $api_instance = DaDaPushClient::DaDaPushMessageApi->new(
);

my $body = DaDaPushClient::Object::MessagePushRequest->new(); # MessagePushRequest | body
my $x_channel_token = "x_channel_token_example"; # string | see: https://www.dadapush.com/channel/list

eval { 
    my $result = $api_instance->create_message(body => $body, x_channel_token => $x_channel_token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DaDaPushMessageApi->create_message: $@\n";
}

Parameters

Name Type Description Notes
body MessagePushRequest body
x_channel_token string see: https://www.dadapush.com/channel/list [optional]

Return type

ResultOfMessagePushResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_message

Result delete_message(message_id => $message_id, x_channel_token => $x_channel_token)

delete a Channel Message

Rate Limit:

  • 10 request per 1s
  • 100 request per 1m
  • 1000 request per 1h

Result code/errmsg List:

  • 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

Example

use Data::Dumper;
use DaDaPushClient::DaDaPushMessageApi;
my $api_instance = DaDaPushClient::DaDaPushMessageApi->new(
);

my $message_id = 789; # int | messageId
my $x_channel_token = "x_channel_token_example"; # string | see: https://www.dadapush.com/channel/list

eval { 
    my $result = $api_instance->delete_message(message_id => $message_id, x_channel_token => $x_channel_token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DaDaPushMessageApi->delete_message: $@\n";
}

Parameters

Name Type Description Notes
message_id int messageId
x_channel_token string see: https://www.dadapush.com/channel/list [optional]

Return type

Result

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_message

ResultOfMessageObject get_message(message_id => $message_id, x_channel_token => $x_channel_token)

get a Channel Message

Rate Limit:

  • 10 request per 1s
  • 100 request per 1m
  • 1000 request per 1h

Result code/errmsg List:

  • 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

Example

use Data::Dumper;
use DaDaPushClient::DaDaPushMessageApi;
my $api_instance = DaDaPushClient::DaDaPushMessageApi->new(
);

my $message_id = 789; # int | messageId
my $x_channel_token = "x_channel_token_example"; # string | see: https://www.dadapush.com/channel/list

eval { 
    my $result = $api_instance->get_message(message_id => $message_id, x_channel_token => $x_channel_token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DaDaPushMessageApi->get_message: $@\n";
}

Parameters

Name Type Description Notes
message_id int messageId
x_channel_token string see: https://www.dadapush.com/channel/list [optional]

Return type

ResultOfMessageObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_messages

ResultOfPageResponseOfMessageObject get_messages(page => $page, page_size => $page_size, x_channel_token => $x_channel_token)

get Message List

Rate Limit:

  • 1 request per 1s
  • 45 request per 1m

Result code/errmsg List:

  • 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

Example

use Data::Dumper;
use DaDaPushClient::DaDaPushMessageApi;
my $api_instance = DaDaPushClient::DaDaPushMessageApi->new(
);

my $page = 1; # int | greater than 1
my $page_size = 10; # int | range is 1,50
my $x_channel_token = "x_channel_token_example"; # string | see: https://www.dadapush.com/channel/list

eval { 
    my $result = $api_instance->get_messages(page => $page, page_size => $page_size, x_channel_token => $x_channel_token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DaDaPushMessageApi->get_messages: $@\n";
}

Parameters

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]

Return type

ResultOfPageResponseOfMessageObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]