Skip to content

Latest commit

 

History

History
232 lines (164 loc) · 10.4 KB

DaDaPushDaDaPushMessageApi.md

File metadata and controls

232 lines (164 loc) · 10.4 KB
Raw

DaDaPushDaDaPushMessageApi

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

-(NSURLSessionTask*) createMessageWithBody: (DaDaPushMessagePushRequest*) body
    xChannelToken: (NSString*) xChannelToken
        completionHandler: (void (^)(DaDaPushResultOfMessagePushResponse* output, NSError* error)) handler;

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

DaDaPushMessagePushRequest* body = [[DaDaPushMessagePushRequest alloc] init]; // body
NSString* xChannelToken = @"xChannelToken_example"; // see: https://www.dadapush.com/channel/list (optional)

DaDaPushDaDaPushMessageApi*apiInstance = [[DaDaPushDaDaPushMessageApi alloc] init];

// push Message to a Channel
[apiInstance createMessageWithBody:body
              xChannelToken:xChannelToken
          completionHandler: ^(DaDaPushResultOfMessagePushResponse* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling DaDaPushDaDaPushMessageApi->createMessage: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
body DaDaPushMessagePushRequest* body
xChannelToken NSString* see: https://www.dadapush.com/channel/list [optional]

Return type

DaDaPushResultOfMessagePushResponse*

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]

deleteMessage

-(NSURLSessionTask*) deleteMessageWithMessageId: (NSNumber*) messageId
    xChannelToken: (NSString*) xChannelToken
        completionHandler: (void (^)(DaDaPushResult* output, NSError* error)) handler;

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

NSNumber* messageId = @56; // messageId
NSString* xChannelToken = @"xChannelToken_example"; // see: https://www.dadapush.com/channel/list (optional)

DaDaPushDaDaPushMessageApi*apiInstance = [[DaDaPushDaDaPushMessageApi alloc] init];

// delete a Channel Message
[apiInstance deleteMessageWithMessageId:messageId
              xChannelToken:xChannelToken
          completionHandler: ^(DaDaPushResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling DaDaPushDaDaPushMessageApi->deleteMessage: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
messageId NSNumber* messageId
xChannelToken NSString* see: https://www.dadapush.com/channel/list [optional]

Return type

DaDaPushResult*

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]

getMessage

-(NSURLSessionTask*) getMessageWithMessageId: (NSNumber*) messageId
    xChannelToken: (NSString*) xChannelToken
        completionHandler: (void (^)(DaDaPushResultOfMessageObject* output, NSError* error)) handler;

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

NSNumber* messageId = @56; // messageId
NSString* xChannelToken = @"xChannelToken_example"; // see: https://www.dadapush.com/channel/list (optional)

DaDaPushDaDaPushMessageApi*apiInstance = [[DaDaPushDaDaPushMessageApi alloc] init];

// get a Channel Message
[apiInstance getMessageWithMessageId:messageId
              xChannelToken:xChannelToken
          completionHandler: ^(DaDaPushResultOfMessageObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling DaDaPushDaDaPushMessageApi->getMessage: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
messageId NSNumber* messageId
xChannelToken NSString* see: https://www.dadapush.com/channel/list [optional]

Return type

DaDaPushResultOfMessageObject*

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]

getMessages

-(NSURLSessionTask*) getMessagesWithPage: (NSNumber*) page
    pageSize: (NSNumber*) pageSize
    xChannelToken: (NSString*) xChannelToken
        completionHandler: (void (^)(DaDaPushResultOfPageResponseOfMessageObject* output, NSError* error)) handler;

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

NSNumber* page = 1; // greater than 1 (default to @1)
NSNumber* pageSize = 10; // range is 1,50 (default to @10)
NSString* xChannelToken = @"xChannelToken_example"; // see: https://www.dadapush.com/channel/list (optional)

DaDaPushDaDaPushMessageApi*apiInstance = [[DaDaPushDaDaPushMessageApi alloc] init];

// get Message List
[apiInstance getMessagesWithPage:page
              pageSize:pageSize
              xChannelToken:xChannelToken
          completionHandler: ^(DaDaPushResultOfPageResponseOfMessageObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling DaDaPushDaDaPushMessageApi->getMessages: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
page NSNumber* greater than 1 [default to @1]
pageSize NSNumber* range is 1,50 [default to @10]
xChannelToken NSString* see: https://www.dadapush.com/channel/list [optional]

Return type

DaDaPushResultOfPageResponseOfMessageObject*

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]