Skip to content

Latest commit

 

History

History
238 lines (166 loc) · 9.8 KB

DaDaPushMessageApi.md

File metadata and controls

238 lines (166 loc) · 9.8 KB
Raw

dadapush_client.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, 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

from __future__ import print_function
import time
import dadapush_client
from dadapush_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = dadapush_client.DaDaPushMessageApi()
body = dadapush_client.MessagePushRequest() # MessagePushRequest | body
x_channel_token = 'x_channel_token_example' # str | see: https://www.dadapush.com/channel/list (optional)

try:
    # push Message to a Channel
    api_response = api_instance.create_message(body, x_channel_token=x_channel_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DaDaPushMessageApi->create_message: %s\n" % e)

Parameters

Name Type Description Notes
body MessagePushRequest body
x_channel_token str 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

HTTP response details

Status code Description Response headers
200 OK -

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

delete_message

Result delete_message(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

from __future__ import print_function
import time
import dadapush_client
from dadapush_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = dadapush_client.DaDaPushMessageApi()
message_id = 56 # int | messageId
x_channel_token = 'x_channel_token_example' # str | see: https://www.dadapush.com/channel/list (optional)

try:
    # delete a Channel Message
    api_response = api_instance.delete_message(message_id, x_channel_token=x_channel_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DaDaPushMessageApi->delete_message: %s\n" % e)

Parameters

Name Type Description Notes
message_id int messageId
x_channel_token str 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

HTTP response details

Status code Description Response headers
200 OK -

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

get_message

ResultOfMessageObject get_message(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

from __future__ import print_function
import time
import dadapush_client
from dadapush_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = dadapush_client.DaDaPushMessageApi()
message_id = 56 # int | messageId
x_channel_token = 'x_channel_token_example' # str | see: https://www.dadapush.com/channel/list (optional)

try:
    # get a Channel Message
    api_response = api_instance.get_message(message_id, x_channel_token=x_channel_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DaDaPushMessageApi->get_message: %s\n" % e)

Parameters

Name Type Description Notes
message_id int messageId
x_channel_token str 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

HTTP response details

Status code Description Response headers
200 OK -

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

get_messages

ResultOfPageResponseOfMessageObject get_messages(page, 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

from __future__ import print_function
import time
import dadapush_client
from dadapush_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = dadapush_client.DaDaPushMessageApi()
page = 1 # int | greater than 1 (default to 1)
page_size = 10 # int | range is 1,50 (default to 10)
x_channel_token = 'x_channel_token_example' # str | see: https://www.dadapush.com/channel/list (optional)

try:
    # get Message List
    api_response = api_instance.get_messages(page, page_size, x_channel_token=x_channel_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DaDaPushMessageApi->get_messages: %s\n" % e)

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

HTTP response details

Status code Description Response headers
200 OK -

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