docs/DaDaPushMessageApi.md

In dadapush/dadapush-r-client: R Package Client for DaDaPush Public API

DaDaPushMessageApi

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

CreateMessage

ResultOfMessagePushResponse CreateMessage(body, x.channel.token=var.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

library(DaDaPushClient)

var.body <- MessagePushRequest$new(list(Action$new("name_example", "type_example", "url_example")), "content_example", "needPush_example", "title_example") # MessagePushRequest | body
var.x.channel.token <- 'x.channel.token_example' # character | see: https://www.dadapush.com/channel/list

#push Message to a Channel
api.instance <- DaDaPushMessageApi$new()
result <- api.instance$CreateMessage(var.body, x.channel.token=var.x.channel.token)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- body | MessagePushRequest| body | x.channel.token | character| 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

DeleteMessage

Result DeleteMessage(message.id, x.channel.token=var.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

library(DaDaPushClient)

var.message.id <- 56 # integer | messageId
var.x.channel.token <- 'x.channel.token_example' # character | see: https://www.dadapush.com/channel/list

#delete a Channel Message
api.instance <- DaDaPushMessageApi$new()
result <- api.instance$DeleteMessage(var.message.id, x.channel.token=var.x.channel.token)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- message.id | integer| messageId | x.channel.token | character| 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

GetMessage

ResultOfMessageObject GetMessage(message.id, x.channel.token=var.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

library(DaDaPushClient)

var.message.id <- 56 # integer | messageId
var.x.channel.token <- 'x.channel.token_example' # character | see: https://www.dadapush.com/channel/list

#get a Channel Message
api.instance <- DaDaPushMessageApi$new()
result <- api.instance$GetMessage(var.message.id, x.channel.token=var.x.channel.token)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- message.id | integer| messageId | x.channel.token | character| 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

GetMessages

ResultOfPageResponseOfMessageObject GetMessages(page, page.size, x.channel.token=var.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

library(DaDaPushClient)

var.page <- 1 # integer | greater than 1
var.page.size <- 10 # integer | range is 1,50
var.x.channel.token <- 'x.channel.token_example' # character | see: https://www.dadapush.com/channel/list

#get Message List
api.instance <- DaDaPushMessageApi$new()
result <- api.instance$GetMessages(var.page, var.page.size, x.channel.token=var.x.channel.token)
dput(result)

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 | character| 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

dadapush/dadapush-r-client documentation built on Nov. 4, 2019, 9:36 a.m.