-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
search.messages.json
84 lines (84 loc) · 7.89 KB
/
search.messages.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
{
"group": "search",
"name": "search.messages",
"deprecated": false,
"desc": "Searches for messages matching a query.",
"args": {
"query": {
"required": true,
"example": "pickleface",
"desc": "Search query.",
"type": "string"
},
"cursor": {
"required": false,
"desc": "Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results.",
"type": "string"
},
"highlight": {
"required": false,
"example": "true",
"desc": "Pass a value of true to enable query highlight markers (see below).",
"type": "boolean"
},
"sort": {
"required": false,
"example": "score",
"desc": "Return matches sorted by either score or timestamp.",
"type": "string"
},
"sort_dir": {
"required": false,
"example": "desc",
"desc": "Change sort direction to ascending (asc) or descending (desc).",
"type": "enum"
},
"team_id": {
"required": false,
"example": "T1234567890",
"desc": "encoded team id to search in, required if org token is used.",
"type": "string"
}
},
"response": {
"examples": [
"{\n \"messages\": {\n \"matches\": [\n {\n \"channel\": {\n \"id\": \"C12345678\",\n \"is_ext_shared\": false,\n \"is_mpim\": false,\n \"is_org_shared\": false,\n \"is_pending_ext_shared\": false,\n \"is_private\": false,\n \"is_shared\": false,\n \"name\": \"general\",\n \"pending_shared\": []\n },\n \"iid\": \"cb64bdaa-c1e8-4631-8a91-0f78080113e9\",\n \"permalink\": \"https://hitchhikers.slack.com/archives/C12345678/p1508284197000015\",\n \"team\": \"T12345678\",\n \"text\": \"The meaning of life the universe and everything is 42.\",\n \"ts\": \"1508284197.000015\",\n \"type\": \"message\",\n \"user\": \"U2U85N1RV\",\n \"username\": \"roach\"\n },\n {\n \"channel\": {\n \"id\": \"C12345678\",\n \"is_ext_shared\": false,\n \"is_mpim\": false,\n \"is_org_shared\": false,\n \"is_pending_ext_shared\": false,\n \"is_private\": false,\n \"is_shared\": false,\n \"name\": \"random\",\n \"pending_shared\": []\n },\n \"iid\": \"9a00d3c9-bd2d-45b0-988b-6cff99ae2a90\",\n \"permalink\": \"https://hitchhikers.slack.com/archives/C12345678/p1508795665000236\",\n \"team\": \"T12345678\",\n \"text\": \"The meaning of life the universe and everything is 101010\",\n \"ts\": \"1508795665.000236\",\n \"type\": \"message\",\n \"user\": \"\",\n \"username\": \"robot overlord\"\n }\n ],\n \"pagination\": {\n \"first\": 1,\n \"last\": 2,\n \"page\": 1,\n \"page_count\": 1,\n \"per_page\": 20,\n \"total_count\": 2\n },\n \"paging\": {\n \"count\": 20,\n \"page\": 1,\n \"pages\": 1,\n \"total\": 2\n },\n \"total\": 2\n },\n \"ok\": true,\n \"query\": \"The meaning of life the universe and everything\"\n}",
"{\n \"error\": \"No query passed\",\n \"ok\": false\n}"
]
},
"errors": {
"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.",
"is_bot": "This method cannot be called by a legacy bot.",
"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."
},
"has_paging": true,
"default_count": 100
}