MessageBird

Operations 27

• Add Contacts To Group
  Add existing contacts to a group. MessageBird accepts at most 50 contact ids in one call, so a longer list is refused here rather than silently truncated.
  messagebird.add_contacts_to_group
• Create Contact
  Add a contact to the account's address book by phone number.
  messagebird.create_contact
• Create Group
  Create a contact group that an SMS send can address by id.
  messagebird.create_group
• Send Verification Token
  Send a one-time token to a phone number or email address and return the verification object whose id the check step needs.
  messagebird.create_verify
• Delete Contact
  Remove a contact from the address book and from every group it is in.
  messagebird.delete_contact
• Delete Group
  Remove a contact group. The contacts in it stay in the address book.
  messagebird.delete_group
• Delete Scheduled Message
  Cancel a message that is still scheduled. A message MessageBird has already handed to an operator cannot be recalled.
  messagebird.delete_message
• Delete Verification
  Invalidate a verification token before it would otherwise expire.
  messagebird.delete_verify
• Get Balance
  Read the account's remaining credit, so a workflow can warn before a campaign runs the balance out. Postpaid accounts always report 0.
  messagebird.get_balance
• Get Contact
  Read one contact back by id, with its group and message counts.
  messagebird.get_contact
• Get Group
  Read one contact group back by id, with how many contacts it holds.
  messagebird.get_group
• Get HLR
  Read the most recent HLR result for a number: its status, the operator holding it, and whether it is roaming or ported.
  messagebird.get_hlr
• Get Message
  Read one message back by id, with the delivery status MessageBird currently holds for each recipient.
  messagebird.get_message
• Get Verification
  Read a verification object back by id to see whether it is still valid.
  messagebird.get_verify
• Get Voice Message
  Read one voice message back by id, with its per-recipient statuses.
  messagebird.get_voice_message
• List Contacts
  List the account's contacts one page at a time.
  messagebird.list_contacts
• List Groups
  List the account's contact groups one page at a time.
  messagebird.list_groups
• List Messages
  List the account's message history, filtered by originator, recipient, direction, status, type, date range or a search term.
  messagebird.list_messages
• List Voice Messages
  List the account's voice-message history, newest first, one page at a time.
  messagebird.list_voice_messages
• Look Up Number
  Validate a phone number and read back its country, its type and its E.164, international, national and RFC3966 formats.
  messagebird.lookup_number
• Remove Contact From Group
  Take one contact out of a group. The contact itself stays in the address book.
  messagebird.remove_contact_from_group
• Request HLR
  Ask the mobile networks whether a number is live and which operator holds it. The query is asynchronous: this returns an HLR object with status 'sent', and the answer arrives on the report URL or from the Get HLR node.
  messagebird.request_hlr
• Send SMS
  Send or schedule an SMS to one or more numbers, or to saved contact groups. MessageBird accepts the message and reports per-recipient delivery afterwards, so the output carries the sent, delivered and failed counts rather than a single success flag.
  messagebird.send_sms
• Send Voice Message
  Call up to 50 numbers and read a text out with text-to-speech. Like an SMS send this is accepted first and delivered afterwards, so the per-recipient counts are reported rather than a single flag.
  messagebird.send_voice_message
• Update Contact
  Change the fields you name on an existing contact and leave the rest as they were.
  messagebird.update_contact
• Update Group
  Rename an existing contact group; its membership is untouched.
  messagebird.update_group
• Check Verification Token
  Check the token the recipient typed against a verification. The returned status is 'verified' on success and 'expired' or 'failed' when the code was late or wrong.
  messagebird.verify_token