syncano-socket-twilio/socket.yml at master · gh3r/syncano-socket-twilio · GitHub

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
name: twilio
version: 0.0.3
description: Send SMS to specified number using twilio socket
author:
  name: Marcin Godlewski

endpoints:
  send_sms:
    description: Send SMS message to given phone number
    file: scripts/sendSMS.js
    parameters:
      from:
        type: string
        description: "Phone number from which message will be send"
        example: "+15005550006"
      to:
        type: string
        description: "Receivers phone number"
        example: "+15005550006"
      body:
        type: string
        description: "Content of the message"
        example: "Hello World from twilio socket"
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  send_mms:
    description: Send MMS message to given phone number
    file: scripts/sendMMS.js
    parameters:
      from:
        type: string
        description: "Phone number from which message will be send"
        example: "+15005550006"
      to:
        type: string
        description: "Receivers phone number"
        example: "+15005550006"
      body:
        type: string
        description: "Content of the message"
        example: "Hello World from twilio socket"
      mediaUrl:
        type: string
        description: "Url to media content"
        example: "https://c1.staticflickr.com/3/2899/14341091933_1e92e62d12_b.jpg"
    response:
      mimetype: text/plain
      examples:
        -
          exit_code: 200
          description: Success
          example: "MMS to +15005550006 was send. Current status: queued."
        -
          exit_code: 400
          description: Failed
          example: "The 'To' number +15005550001 is not a valid phone number."
  get_message:
    description: Get message details with given SID
    file: scripts/getMessage.js
    parameters:
      message_sid:
        type: string
        description: "SID of message you want retrive"
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  list_messages:
    description: Display all messages with they details
    file: scripts/listMessages.js
    parameters:
      dummy:
        type: string
        description: Just dummy parameter to call list, ignore it
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  call:
    description: Make a call to given phone number
    file: scripts/call.js
    parameters:
      from:
        type: string
        description: "Phone number from which call will be executed"
        example: "+15005550006"
      to:
        type: string
        description: "Receivers phone number"
        example: "+15005550006"
      url:
        type: string
        description: "The fully qualified URL that should be consulted when the call connects."
        example: http://demo.twilio.com/docs/voice.xml
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  create_queue:
    description: Create call queue
    file: scripts/createQueue.js
    parameters:
      name:
        type: string
        description: "Friendly name for call queue"
        example: "newqueue"
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  get_queue:
    description: Get queue information by SID
    file: scripts/getQueue.js
    parameters:
      sid:
        type: string
        description: Queue SID that you want to get
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  update_queue:
    description: Update given queue by changing FriendlyName or MaxSize
    file: scripts/updateQueue.js
    parameters:
      sid:
        type: string
        description: Queue sid number
      name:
        type: string
        description: Queue friendly name
      size:
        type: string
        description: Queue max size
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
  list_queues:
    description: Display all available queues
    file: scripts/listQueues.js
    parameters:
      dummy:
        type: string
        description: Just dummy parameter to call list, ignore it
    response:
      mimetype: application/json
      examples:
        -
          exit_code: 200
          description: Success
        -
          exit_code: 400
          description: Failed
config:
  accountSid:
    value: <Twilio Account Sid>
  accountToken:
    value: <Twilio Account Token>