NAME
SMS::MessageBird::API::Voice - Sub-module for the SMS::MessageBird distribution.
SYNOPSIS
This is a sub-module which is part of the SMS::MessageBird distribution.
While this module can be used directly, it's designed to be used via SMS::MessageBird
DESCRIPTION
This module provides the interface to the Text-to-Voice SMS related methods of the MessageBird JSON API.
The methods implmented acceept the paramteres as named in the MessageBird API documentation which can be found at the MessageBird Developer Documentation. If you're using this distribution you should be familiar with the API documentation.
Response Data
Every method returns a standardised hashref containin the following keys:
- ok
-
Value of 0 or 1. Indicates if the request was completed successfully or not. This value is based on LWP::UserAgent's is_success() method.
- code
-
This is the HTTP code returned by the API. In the event of ok => 0 - it's possible that the request was a 401 etc. So this is provided for sanity checking.
- content
-
This is a Perl hashref data structure decoded from the API's response JSON as-is.
Please see the MessageBird Developer Documentation for more information on the expected structure.
Text-to-Voice formatting.
Text-to-Voice SMS can be tweeked to alter the speed of reading and add delays in the spoken text. Please see the "The Voice Body" section of the MessageBird Developer Documentation for more information.
METHODS
send
In: %params - Hash of params accepted by the MessageBird API.
Out: $response - Hashref of response data. See "Response Data" above.This method implements the POST /voicemessages route of the API.
Accepted parameters are listed in the MessageBird API documentation.
Require parameters are as follows:
- originator
-
The originator parameter is required but can be omitted if set when instantiating the SMS::MessageBird module.
- recipients
-
The recipients parameter is required and can be either a scalar containing a single MSISDN (mobile number) or an arrayref containing many recipients.
- body
-
The body parameter is required. Scalar containing the text of the message.
Text-to-Voice SMS can be tweeked to alter the speed of reading and add delays in the spoken text. Please see the "The Voice Body" section of the MessageBird Developer Documentation for more information.
All other parameters are optional.
Please see the MessageBird API Documentation for more information.
receive
In: $voice_mesasge_id - Optional ID of the voice message to recieve.
Out: $response - Hashref of response data. See "Response Data" above.This method implements the GET /voicemessages/{voice_message_id} route of the API.
If supplied with a $voice_message_id, that one message will be returned. If omitted, a complete list of messages will be returned.
Please see the MessageBird API Documentation for more information.
get
Synonym for the receive() method.
remove
In: $voice_message_id - The voice message_id to remove.
Out: $response - Hashref of response data. See "Response Data" above.This method implements the DELETE /voicemessages/{message_id} route of the API.
Deletes the SMS with identifier $message_id.
Please see the MessageBird API Documentation for more information.
del
Synonym for the remove() method.
AUTHOR
James Ronan, <james at ronanweb.co.uk>
BUGS
Please report any bugs or feature requests to bug-sms-messagebird at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SMS-MessageBird. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
Alternatively you can raise an issue on the source code which is available on GitHub.
LICENSE AND COPYRIGHT
Copyright 2016 James Ronan.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.