Publish message to channel
Publish JSON to a channel using the POST request.
Path Parameters |
---|
pub_key string — REQUIREDYou app’s publish key from Admin Portal. Example: pub-c-50264475-1902-558x-b37b-56d7fb64bf45 |
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. Example: sub-c-50264475-1902-558x-d213-7p19052012n2 |
channel string — REQUIREDThe channel name to perform the operation on. Example: myChannel |
callback string — REQUIREDThe JSONP callback name to wrap the function in. Use Example (myCallback): myCallback Example (zero): 0 |
Query Parameters |
---|
store integerThis parameter overrides the default account configuration on message saving. |
auth stringString which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Example: myAuthKey |
meta stringJSON with additional information. Contains additional information about the message, which can be used for stream filtering. Value must be a JSON stringified and URI encoded string. Example (meta sample): %7B%22cool%22%3A%22meta%22%7D |
uuid stringA UTF-8 encoded string of up to 64 characters used to identify the client. Example: myUniqueUserId |
ttl integerSet a per-message time-to-live in Message Persistence:
Example: 1 |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if the |
type stringPossible values: 3 ≤ length ≤ 50 User-specified message type string - limited by 3-50 case-sensitive alphanumeric characters with only [a-zA-Z0-9-_*] |
space-id stringPossible values: 3 ≤ length ≤ 50 User-specified space ID string - limited by 3-50 case-sensitive alphanumeric characters with only [a-zA-Z0-9-_*] |
Request Body — REQUIRED Contains a message to be published on a channel. |
---|
message string |
Responses | ||||
---|---|---|---|---|
200 OK
| ||||
400 Bad Request
| ||||
403 Forbidden
| ||||
413 Message payload is too large (>=32K)
| ||||
429 Request rate limit exceeded
|