List Messages

GET /messages
Copied
Arrow
                https://api.ocamba.com/v1/hood/messages

Returns a list of Messages

query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
outstring
Data format output - 'csv' (default) or 'json'.


Example: out=json
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
idinteger
A unique identifier generated by the Ocamba.


Example: 1037
namestring
Message name.


Example: message_example
require_interactioninteger
Demand action execution from the user. Applicable only for desktop users.


Example: 1
renotifyinteger
Replacing old notification with the new one using the silent method. Applicable only with tag option.
silentinteger
Serving notification without sound and vibration. Applicable only to mobile devices.
create_timestring
Date amd time the message was created.


Example: 2021-11-01
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ message ]
An array of all created items.
Message
Name
Description
actions[ object ]
Content of the action button presented to the user.


Example: [ { "title": { "en": "en_title" }, "icon": "https://example.com", "url": "https://example.com" } ]
badgestring
Monochromatic mini-icon which portrays to user source where he subscribed in the first place.


Example: https://www.badgeexample.com
bodyobject
Brief title-related textual addition as pairs of keys and values, where key represents language and value body in that language.


Example: { "en": "en_body" "de": "de_body" }
company_idstring
A unique company identifier generated by the Ocamba.


Example: 1234321
iconstring
Secondary visual attribute presented to the user.


Example: https://www.iconexample.com
idstring
A unique identifier generated by the Ocamba.


Example: 1018
imageobject
Image addresses as pairs of key and value, where key represents language and value image for that language region.


Example: { "en": "https://example.com" }
landing_urlstring
Page address where the user will land after clicking on it. Max length is 2048 characters.


Example: https://www.landingurlexample.com
namestring
Message name.


Example: msg_example
renotifyinteger
Replacing old notification with the new one using the silent method. Applicable only with tag option.
require_interactioninteger
Demand action execution from the user. Applicable only for desktop users.


Example: 1
silentinteger
Serving notification without sound and vibration. Applicable only to mobile devices.


Example: 1
tagstring
This option enables the removal of notifications with the same tag which were delivered earlier.


Example: tag
titleobject
The main textual aspect as pairs of keys and values, where key represents language and value title in that language.


Example: { "en": "en_title" "de": "de_title" }
vibrationstring
Two vibration pulses with customizable length and pause between them, described in milliseconds (200,100,200 formats), will start when a notification is displayed. Applicable only for Android users.


Example: 100,100
totalinteger
A total number of items.


Example: 122
tip
1 Searchable field is name.
2 Sortable fields are: name and create_time.
3 Filterable fields are: id, name and create_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 122,
  "items": [
    {
      "id": "1",
      "company_id": "123456",
      "name": "my_msg",
      "title": {
          "ar": "ar_title",
          "ca": "ca_title",
          "cs": "cs_title",
          "en": "en_title",
          "hr": "hr_title",
          "zh": "zh_title"
      },
      "landing_url": "https://example.com",
      "require_interaction": 0,
      "renotify": 0,
      "silent": 0,
      "actions": [
        {
          "title": {
            "en": "en_title"
          }
        }
      ],
      "create_time": "2021-10-23 08:10:32"
    }
  ]
}

{
  "total": 122,
  "items": [
    {
      "id": "1018",
      "company_id": "1234321",
      "name": "msg_example",
      "title": "{\n  \"en\": \"en_title\"\n  \"de\": \"de_title\"\n}",
      "body": "{\n  \"en\": \"en_body\"\n  \"de\": \"de_body\"\n}",
      "image": "{\n  \"en\": \"https://example.com\"\n}",
      "icon": "https://www.iconexample.com",
      "landing_url": "https://www.landingurlexample.com",
      "tag": "tag",
      "require_interaction": 1,
      "silent": 1,
      "vibration": "100,100",
      "badge": "https://www.badgeexample.com",
      "actions": [
        null
      ]
    }
  ]
}