Messente logo

Phonebook API

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

Contacts

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

  • Select Contacts and filter by Groups
  • Fetch Contact details
  • Create a new Contact
  • Update an existing Contacts
  • Add or remove a Contact from a Group
  • Delete a Contact

Bear in mind, that when deleting a Contact, it will be lost and can not be restored.

Select all Contacts 

GET /v1/phonebook/contacts

Successful Response

HTTP/1.1 200
{
  "contacts": [
    {
      "phoneNumber": "+4400000000",
      "email": null,
      "firstName": null,
      "lastName": null,
      "company": null,
      "title": null,
      "custom": null,
      "custom2": null,
      "custom3": null,
      "custom4": null
    },
    {
      "phoneNumber": "+4400000001",
      "email": null,
      "firstName": "John",
      "lastName": "Doe",
      "company": null,
      "title": null,
      "custom": null,
      "custom2": null,
      "custom3": null,
      "custom4": null
    }
  ]
}

Create a new Contact

POST /v1/phonebook/contacts
{
  "phoneNumber": "+4400000000",
  "email": null,
  "firstName": null,
  "lastName": null,
  "company": null,
  "title": null,
  "custom": null,
  "custom2": null,
  "custom3": null,
  "custom4": null
}

Successful Response

HTTP/1.1 201

Update a Contact

PATCH /v1/phonebook/contacts/{phone-number}
{
  "firstName": "Jack"
}

Successful Response

HTTP/1.1 200
{
  "phoneNumber": "+4400000000",
  "email": null,
  "firstName": "Jack",
  "lastName": null,
  "company": null,
  "title": null,
  "custom": null,
  "custom2": null,
  "custom3": null,
  "custom4": null
}

Delete a Contact

DELETE /v1/phonebook/contacts/{phone-number}

Successful Response

HTTP/1.1 204