Phonebook API

Phonebook API enables you to use our blacklisting feature to make sure you're not sending any unwanted messages.

Groups

Every contact in the Phonebook may belong to one or many Groups, which makes it easy to send targeted messages just by selecting the Groups you want.

You can think of Groups also as Labels that each Contacts can have.

When sending message to multiple groups, Messente only sends one message per Contact. This means you can send messages without having to worry about duplicate messages being sent.

Using the Phonebook API you can

  • List all Groups
  • Create a new Group
  • Update an existing Group
  • Delete a Group

Bear in mind, that when deleting a Group, all the Contacts remain in the Phonebook.

List all Groups

GET /v1/phonebook/groups

Successful Response

HTTP/1.1 200
{
  "groups": [
    {
      "id": "e9f2e77f-5774-48b5-8cb8-f28a6bfcbd0c",
      "name": "Technical",
      "createdOn": "2019-04-22T12:18:59.526637Z",
      "contactsCount": 8732
    },
    {
      "id": "e9f2e77f-5774-48b5-8cb8-f28a6bfcbd0c",
      "name": "Marketing",
      "createdOn": "2019-04-22T12:18:59.526637Z",
      "contactsCount": 3627
    }
  ]
}

Create a new Group

POST /v1/phonebook/groups
{
  "name": "Business"
}

Successful Response

HTTP/1.1 201

Update a Group

PUT /v1/phonebook/groups/{group-id}
{
  "name": "Development"
}

Successful Response

HTTP/1.1 200

Delete a Group

DELETE /v1/phonebook/groups/{group-id}

Successful Response

HTTP/1.1 204