-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
chat.postEphemeral.json
142 lines (142 loc) · 8.36 KB
/
chat.postEphemeral.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{
"group": "chat",
"name": "chat.postEphemeral",
"deprecated": false,
"desc": "Sends an ephemeral message to a user in a channel.",
"args": {
"channel": {
"required": true,
"example": "C1234567890",
"desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.",
"type": "channel"
},
"user": {
"required": true,
"example": "U0BPQUNTA",
"desc": "id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.",
"type": "user"
},
"attachments": {
"required": false,
"example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]",
"desc": "A JSON-based array of structured attachments, presented as a URL-encoded string.",
"type": "string",
"format": "json"
},
"blocks": {
"required": false,
"example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]",
"desc": "A JSON-based array of structured blocks, presented as a URL-encoded string.",
"type": "blocks[] as string",
"format": "json"
},
"text": {
"required": false,
"example": "Hello world",
"desc": "How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.",
"type": "string"
},
"as_user": {
"required": false,
"example": "true",
"desc": "(Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.",
"type": "boolean"
},
"icon_emoji": {
"required": false,
"example": ":chart_with_upwards_trend:",
"desc": "Emoji to use as the icon for this message. Overrides icon_url.",
"type": "string"
},
"icon_url": {
"required": false,
"example": "http://lorempixel.com/48/48",
"desc": "URL to an image to use as the icon for this message.",
"type": "string"
},
"link_names": {
"required": false,
"example": "true",
"desc": "Find and link channel names and usernames.",
"type": "boolean"
},
"parse": {
"required": false,
"example": "full",
"desc": "Change how messages are treated. Defaults to none. See below.",
"type": "string"
},
"thread_ts": {
"required": false,
"example": "1234567890.123456",
"desc": "Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.",
"type": "string"
},
"username": {
"required": false,
"example": "My Bot",
"desc": "Set your bot's user name.",
"type": "string"
}
},
"arg_groups": [
{
"args": [
"attachments",
"blocks",
"text"
],
"desc": "One of these arguments is required to describe the content of the message. If attachments or blocks are included, text will be used as fallback text for notifications only.",
"mutually_exclusive": false
}
],
"response": {
"examples": [
"{\n \"ok\": true,\n \"message_ts\": \"1502210682.580145\"\n}",
"{\n \"ok\": false,\n \"error\": \"user_not_in_channel\"\n}"
]
},
"errors": {
"channel_not_found": "Value passed for channel was invalid.",
"invalid_blocks": "Blocks submitted with this message are not valid.",
"invalid_blocks_format": "The blocks is not a valid JSON object or doesn't match the Block Kit syntax.",
"is_archived": "Channel has been archived.",
"message_limit_exceeded": "Members on this team are sending too many messages. For more details, see https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces.",
"messages_tab_disabled": "Messages tab for the app is disabled.",
"msg_too_long": "Message text is too long.",
"no_text": "No message text provided.",
"restricted_action": "A workspace preference prevents the authenticated user from posting.",
"too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.",
"user_not_in_channel": "Intended recipient is not in the specified channel.",
"access_denied": "Access to a resource specified in the request is denied.",
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
"method_deprecated": "The method has been deprecated.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"token_expired": "Authentication token has expired.",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
"two_factor_setup_required": "Two factor setup is required.",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"accesslimited": "Access to this method is limited on the current network.",
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
"service_unavailable": "The service is temporarily unavailable.",
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete."
}
}