File Coverage

blib/lib/SMS/MessageBird/API/Voice.pm

Criterion	Covered	Total	%
statement	9	21	42.8
branch	0	4	0.0
condition			n/a
subroutine	3	8	37.5
pod	5	5	100.0
total	17	38	44.7

package SMS::MessageBird::API::Voice;

use strict;
use warnings;

use parent 'SMS::MessageBird::API';

=head1 NAME

SMS::MessageBird::API::Voice - Sub-module for the SMS::MessageBird distribution.


=head1 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
L


=head1 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 L.
If you're using this distribution you should be familiar with the API
documentation.

=head2 Response Data

Every method returns a standardised hashref containin the following keys:

=over

=item 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.

=item 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.

=item content

This is a Perl hashref data structure decoded from the API's response JSON
as-is.

Please see the L
for more information on the expected structure.

=back

=head2 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
L
for more information.


=head1 METHODS


=head2 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:

=over

=item originator

The originator parameter is required but can be omitted if set when
instantiating the SMS::MessageBird module.

=item recipients

The recipients parameter is required and can be either a scalar containing a
single MSISDN (mobile number) or an arrayref containing many recipients.

=item 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
L
for more information.

=back

All other parameters are optional.

Please see the L
for more information.

=cut

sub send {
    my ($self, %params) = @_;

    return $self->_api_request(
        post => '/voicemessages',
        \%params
    );
}


=head2 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 L
for more information.

=cut

sub receive {
    my ($self, $voice_message_id) = @_;

    my $route = ($voice_message_id) ? "/voicemessages/$voice_message_id"
                                    : '/voicemessages';

    return $self->_api_request( get => $route );
}


=head2 get

Synonym for the L method.

=cut

sub get {
    my ($self, $voice_message_id) = @_;
    return $self->receive($voice_message_id);
}


=head2 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 L
for more information.

=cut

sub remove {
    my ($self, $voice_message_id) = @_;

    return $self->_no_param_supplied('voice message ID') if !$voice_message_id;

    return $self->_api_request( delete => "/voicemessages/$voice_message_id" );
}


=head2 del

Synonym for the L method.

=cut

sub del {
    my ($self, $voice_message_id) = @_;
    return $self->remove($voice_message_id);
}


=head1 AUTHOR

James Ronan, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C,
or through the web interface at L.
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
L.

=head1 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.

=cut

1;