File: voice.rb

package info (click to toggle)
ruby-telesign 4.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 96 kB
  • sloc: ruby: 249; makefile: 4
file content (33 lines) | stat: -rw-r--r-- 1,067 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
require 'telesign/rest'

VOICE_RESOURCE = '/v1/voice'
VOICE_STATUS_RESOURCE = '/v1/voice/%{reference_id}'

module Telesign

  # TeleSign's Voice API allows you to easily send voice messages. You can send alerts, reminders, and notifications,
  # or you can send verification messages containing time-based, one-time passcodes (TOTP).
  class VoiceClient < RestClient

    # Send a voice call to the target phone_number.
    #
    # See https://developer.telesign.com/docs/voice-api for detailed API documentation.
    def call(phone_number, message, message_type, **params)

      self.post(VOICE_RESOURCE,
                phone_number: phone_number,
                message: message,
                message_type: message_type,
                **params)
    end

    # Retrieves the current status of the voice call.
    #
    # See https://developer.telesign.com/docs/voice-api for detailed API documentation.
    def status(reference_id, **params)

      self.get(VOICE_STATUS_RESOURCE % {:reference_id => reference_id},
               **params)
    end
  end
end