Skip to content

Latest commit

 

History

History
218 lines (142 loc) · 7.71 KB

DaDaPushMessageApi.md

File metadata and controls

218 lines (142 loc) · 7.71 KB
Raw

DaDaPushClient::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, opts)

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

# load the gem
require 'dadapush_client'

api_instance = DaDaPushClient::DaDaPushMessageApi.new
body = DaDaPushClient::MessagePushRequest.new # MessagePushRequest | body
opts = {
  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
}

begin
  #push Message to a Channel
  result = api_instance.create_message(body, opts)
  p result
rescue DaDaPushClient::ApiError => e
  puts "Exception when calling DaDaPushMessageApi->create_message: #{e}"
end

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

delete_message

Result delete_message(message_id, opts)

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

# load the gem
require 'dadapush_client'

api_instance = DaDaPushClient::DaDaPushMessageApi.new
message_id = 56 # Integer | messageId
opts = {
  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
}

begin
  #delete a Channel Message
  result = api_instance.delete_message(message_id, opts)
  p result
rescue DaDaPushClient::ApiError => e
  puts "Exception when calling DaDaPushMessageApi->delete_message: #{e}"
end

Parameters

Name Type Description Notes
message_id Integer 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

get_message

ResultOfMessageObject get_message(message_id, opts)

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

# load the gem
require 'dadapush_client'

api_instance = DaDaPushClient::DaDaPushMessageApi.new
message_id = 56 # Integer | messageId
opts = {
  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
}

begin
  #get a Channel Message
  result = api_instance.get_message(message_id, opts)
  p result
rescue DaDaPushClient::ApiError => e
  puts "Exception when calling DaDaPushMessageApi->get_message: #{e}"
end

Parameters

Name Type Description Notes
message_id Integer 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

get_messages

ResultOfPageResponseOfMessageObject get_messages(page, page_size, opts)

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

# load the gem
require 'dadapush_client'

api_instance = DaDaPushClient::DaDaPushMessageApi.new
page = 1 # Integer | greater than 1
page_size = 10 # Integer | range is 1,50
opts = {
  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
}

begin
  #get Message List
  result = api_instance.get_messages(page, page_size, opts)
  p result
rescue DaDaPushClient::ApiError => e
  puts "Exception when calling DaDaPushMessageApi->get_messages: #{e}"
end

Parameters

Name Type Description Notes
page Integer greater than 1 [default to 1]
page_size Integer 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