6.0.0 • Published 5 years ago

@datafire/zoomconnect

Licence

MIT

Version

6.0.0

Deps

Size

115 kB

Vulns

Weekly

Stars

135

Summary Dependency Versions

@datafire/zoomconnect

Client library for www.zoomconnect.com

Installation and Usage

npm install --save @datafire/zoomconnect

let zoomconnect = require('@datafire/zoomconnect').create({
  email: "",
  token: ""
});

.then(data => {
  console.log(data);
});

Actions

getBalance

Returns your account's credit balance

zoomconnect.getBalance(null, context)

Returns data from the statistics report. Note that by default the statistics shown are based on the number of messages, use the calculateCreditValue should you wish to calculate the statistics based on credit value.

zoomconnect.getStatistics({}, context)

Input

input object
- from string: date format: dd-MM-yyyy
- to string: date format: dd-MM-yyyy
- userEmailAddress string: optional email address of user to return statistics for a single user, default is to return statistics for all users if administrator, or statistics for your own account if not an administrator
- campaign string: optional campaign name
- includeRefundedAndOptout boolean: optionally include refunded and optout counts, default is false
- calculateCreditValue boolean: optionally calculate using credit value rather than message count, default is false

Output

output WebServiceAccountStatistics

transfer

Transfers credits between two users in the same team. The account email address fields as well as the number of credits to transfer are required.

zoomconnect.transfer({}, context)

Input

input object
- body WebServiceTransferCreditsRequest

Output

output WebServiceUser

search

Find a user for a particular email address

zoomconnect.search({
  "searchEmail": ""
}, context)

Input

input object
- searchEmail required string: search by email address

Output

output WebServiceUsers

account.user.put

Creates a new sub-account in your team. The following fields are required firstname, lastname, email address, contact number and password.

zoomconnect.account.user.put({}, context)

Input

input object
- body WebServiceUser

Output

output WebServiceUser

getUser

Gets a user from a given user id

zoomconnect.getUser({
  "userId": 0
}, context)

Input

input object
- userId required integer: userId

Output

output WebServiceUser

account.user.userId.post

Updates a sub-account in your team. The following fields can be updated firstname, lastname, contact number and password.

zoomconnect.account.user.userId.post({
  "userId": 0
}, context)

Input

input object
- userId required integer: userId
- body WebServiceUser

Output

output WebServiceUser

contacts.all.get

Returns all contacts

zoomconnect.contacts.all.get(null, context)

Input

This action has no parameters

Output

output WebServiceContacts

contacts.create.post

Creates a contact

zoomconnect.contacts.create.post({}, context)

Input

input object
- body WebServiceContact

Output

output WebServiceContact

contacts.contactId.delete

Deletes a contact

zoomconnect.contacts.contactId.delete({
  "contactId": ""
}, context)

Input

input object
- contactId required string: contactId

Output

Output schema unknown

contacts.contactId.get

Returns details for a single contact

zoomconnect.contacts.contactId.get({
  "contactId": ""
}, context)

Input

input object
- contactId required string: contactId

Output

output WebServiceContact

contacts.contactId.post

Updates a contact

zoomconnect.contacts.contactId.post({
  "contactId": ""
}, context)

Input

input object
- contactId required string: contactId
- body WebServiceContact

Output

output WebServiceContact

contacts.contactId.addFromGroup.groupId.get

Remove a contact from a group

zoomconnect.contacts.contactId.addFromGroup.groupId.get({
  "contactId": "",
  "groupId": ""
}, context)

Input

input object
- contactId required string: contactId
- groupId required string: groupId

Output

Output schema unknown

contacts.contactId.addFromGroup.groupId.post

Remove a contact from a group

zoomconnect.contacts.contactId.addFromGroup.groupId.post({
  "contactId": "",
  "groupId": ""
}, context)

Input

input object
- contactId required string: contactId
- groupId required string: groupId

Output

Output schema unknown

contacts.contactId.addToGroup.groupId.get

Add a contact to a group

zoomconnect.contacts.contactId.addToGroup.groupId.get({
  "contactId": "",
  "groupId": ""
}, context)

Input

input object
- contactId required string: contactId
- groupId required string: groupId

Output

Output schema unknown

contacts.contactId.addToGroup.groupId.post

Add a contact to a group

zoomconnect.contacts.contactId.addToGroup.groupId.post({
  "contactId": "",
  "groupId": ""
}, context)

Input

input object
- contactId required string: contactId
- groupId required string: groupId

Output

Output schema unknown

groups.all.get

Returns all groups

zoomconnect.groups.all.get(null, context)

Input

This action has no parameters

Output

output WebServiceGroups

groups.create.post

Create a group

zoomconnect.groups.create.post({}, context)

Input

input object
- body WebServiceGroup

Output

output WebServiceGroup

groups.groupId.delete

Deletes a group

zoomconnect.groups.groupId.delete({
  "groupId": ""
}, context)

Input

input object
- groupId required string: groupId

Output

Output schema unknown

groups.groupId.get

Returns details for a single group

zoomconnect.groups.groupId.get({
  "groupId": ""
}, context)

Input

input object
- groupId required string: groupId

Output

output WebServiceGroup

groups.groupId.post

Update a group

zoomconnect.groups.groupId.post({
  "groupId": ""
}, context)

Input

input object
- groupId required string: groupId
- body WebServiceGroup

Output

output WebServiceGroup

groups.groupId.addContact.contactId.get

Add a contact to a group

zoomconnect.groups.groupId.addContact.contactId.get({
  "groupId": "",
  "contactId": ""
}, context)

Input

input object
- groupId required string: groupId
- contactId required string: contactId

Output

Output schema unknown

groups.groupId.addContact.contactId.post

Add a contact to a group

zoomconnect.groups.groupId.addContact.contactId.post({
  "groupId": "",
  "contactId": ""
}, context)

Input

input object
- groupId required string: groupId
- contactId required string: contactId

Output

Output schema unknown

groups.groupId.removeContact.contactId.get

Remove a contact from a group

zoomconnect.groups.groupId.removeContact.contactId.get({
  "groupId": "",
  "contactId": ""
}, context)

Input

input object
- groupId required string: groupId
- contactId required string: contactId

Output

Output schema unknown

groups.groupId.removeContact.contactId.post

Remove a contact from a group

zoomconnect.groups.groupId.removeContact.contactId.post({
  "groupId": "",
  "contactId": ""
}, context)

Input

input object
- groupId required string: groupId
- contactId required string: contactId

Output

Output schema unknown

messages.all.get

Returns all messages

zoomconnect.messages.all.get({}, context)

Input

input object
- pageSize integer: number of elements to return at a time
- page integer: page number
- type string (values: OUTBOUND, INBOUND): filter by message type
- status string (values: SCHEDULED, UNKNOWN, SENT, FAILED, FAILED_REFUNDED, FAILED_OPTOUT, DELIVERED): filter by message status
- fromDateTimeSent string: date format: yyyyMMdd
- toDateTimeSent string: date format: yyyyMMdd
- fromDateTimeReceived string: date format: yyyyMMdd
- toDateTimeReceived string: date format: yyyyMMdd
- fromNumber string: phone number the message was sent from
- toNumber string: phone number the message was sent to
- message string: search matching message text
- campaign string: search by campaign
- dataField string: search by data field
- deleted boolean: return only deleted / not deleted messages
- read boolean: return only read / unread messages (inbox messages only)
- repliesToMessageId string: return only inbox messages which are a reply to the message with the given message id

Output

output WebServiceMessages

messages.analyse.full.post

Returns full analysis of message

zoomconnect.messages.analyse.full.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageAndRecipientNumber

Output

output WebServiceAnalyseMessageResponse

messages.analyse.message_credit_cost.post

Returns the number of credit which would be required to send the request message to the requested recipient number

zoomconnect.messages.analyse.message_credit_cost.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageAndRecipientNumber

Output

output number

messages.analyse.message_encoding.post

Returns the message encoding that would be required to send the requested message

zoomconnect.messages.analyse.message_encoding.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageOnly

Output

output string

messages.analyse.message_length.post

Returns the number of characters the requested message consists of

zoomconnect.messages.analyse.message_length.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageOnly

Output

output integer

messages.analyse.message_length_within_max_allowed.post

Returns details for a single message

zoomconnect.messages.analyse.message_length_within_max_allowed.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageOnly

Output

output boolean

messages.analyse.number_of_messages.post

Returns the number of SMS parts which would be sent when sending the requested message

zoomconnect.messages.analyse.number_of_messages.post({}, context)

Input

input object
- body WebServiceAnalyseMessageRequestMessageOnly

Output

output integer

messages.messageId.delete

Deletes a message

zoomconnect.messages.messageId.delete({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

Output schema unknown

messages.messageId.get

Returns details for a single message

zoomconnect.messages.messageId.get({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceMessage

messages.messageId.markRead.post

Marks a message as read

zoomconnect.messages.messageId.markRead.post({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceMessage

messages.messageId.markRead.put

Marks a message as read

zoomconnect.messages.messageId.markRead.put({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceMessage

messages.messageId.markUnread.post

Marks a message as unread

zoomconnect.messages.messageId.markUnread.post({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceMessage

messages.messageId.markUnread.put

Marks a message as unread

zoomconnect.messages.messageId.markUnread.put({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceMessage

sms.send.get

Returns an example of the data to POST to send a single message.

zoomconnect.sms.send.get(null, context)

Input

This action has no parameters

Output

output WebServiceSendSmsRequest

sms.send.post

Sends a single message. The recipientNumber and message fields are required. All other fields are optional.

zoomconnect.sms.send.post({}, context)

Input

input object
- body WebServiceSendSmsRequest

Output

output WebServiceSendSmsResponse

sms.send_bulk.get

Returns an example of the data to POST to send multiple messages in one transaction.

zoomconnect.sms.send_bulk.get(null, context)

Input

This action has no parameters

Output

output WebServiceSendSmsRequests

sms.send_bulk.post

Send multiple messages in one transaction.

zoomconnect.sms.send_bulk.post({}, context)

Input

input object
- body WebServiceSendSmsRequests

Output

output WebServiceSendSmsResponses

sms.send_url_parameters.get

Send a single message using URL parameters.The recipientNumber and message parameters are required. All other parameters are optional.

zoomconnect.sms.send_url_parameters.get({
  "recipientNumber": "",
  "message": ""
}, context)

Input

input object
- recipientNumber required string: the phone number of the recipient to send to
- message required string: the message to send
- dateToSend string: date format: yyyyMMddHHmm
- campaign string: optional campaign name
- dataField string: optional extra data

Output

output string

sms.send_url_parameters.post

Send a single message using URL parameters.The recipientNumber and message parameters are required. All other parameters are optional.

zoomconnect.sms.send_url_parameters.post({
  "recipientNumber": "",
  "message": ""
}, context)

Input

input object
- recipientNumber required string: the phone number of the recipient to send to
- message required string: the message to send
- dateToSend string: date format: yyyyMMddHHmm
- campaign string: optional campaign name
- dataField string: optional extra data

Output

output string

sms.send_url.token.get

Send a single message using your unique URL without having to authenticate using your email address or REST API token. The token required is the URL Sending token available on the developer setting page. The recipientNumber and message parameters are required. All other parameters are optional. Not that the token required here is

zoomconnect.sms.send_url.token.get({
  "token": "",
  "recipientNumber": "",
  "message": ""
}, context)

Input

input object
- token required string: token
- recipientNumber required string: the phone number of the recipient to send to
- message required string: the message to send
- dateToSend string: date format: yyyyMMddHHmm
- campaign string: optional campaign name
- dataField string: optional extra data

Output

output string

sms.send_url.token.post

zoomconnect.sms.send_url.token.post({
  "token": "",
  "recipientNumber": "",
  "message": ""
}, context)

Input

input object
- token required string: token
- recipientNumber required string: the phone number of the recipient to send to
- message required string: the message to send
- dateToSend string: date format: yyyyMMddHHmm
- campaign string: optional campaign name
- dataField string: optional extra data

Output

output string

templates.all.get

Returns all templates

zoomconnect.templates.all.get(null, context)

Input

This action has no parameters

Output

output WebServiceTemplates

templates.templateId.delete

Deletes a template

zoomconnect.templates.templateId.delete({
  "templateId": 0
}, context)

Input

input object
- templateId required integer: templateId

Output

Output schema unknown

templates.templateId.get

Returns details for a single template

zoomconnect.templates.templateId.get({
  "templateId": 0
}, context)

Input

input object
- templateId required integer: templateId

Output

output WebServiceTemplate

voice.all.get

Returns all voice messages

zoomconnect.voice.all.get({}, context)

Input

input object
- pageSize integer: number of elements to return at a time
- page integer: page number
- status string (values: SCHEDULED, UNKNOWN, SENT, FAILED, FAILED_REFUNDED, FAILED_OPTOUT, DELIVERED): filter by message status
- fromDateTimeSent string: date format: yyyyMMdd
- toDateTimeSent string: date format: yyyyMMdd
- toNumber string: phone number the message was sent to
- message string: search matching message text
- campaign string: search by campaign
- dataField string: search by data field
- deleted boolean: return only deleted / not deleted messages

Output

output WebServiceVoiceMessages

voice.single_audio.post

Send a single audio voice message to one recipient. Note, Content-Type header must be set to multipart/form-data for this request.

zoomconnect.voice.single_audio.post({
  "file": "",
  "recipientNumber": ""
}, context)

Input

input object
- file required string, object: audio file to play, supports MP3 or WAV format
  - content string
  - encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
  - contentType string
  - filename string
- recipientNumber required string: the phone number of the recipient to send to
- campaign string: optional campaign name
- dataField string: optional extra data
- retryCount integer: optional number of times to retry unanswered call
- retryMinimumInterval integer: optional minimum interval in minutes between retry attempts
- retryMaximumInterval integer: optional maximum interval in minutes between retry attempts

Output

output WebServiceSendVoiceMessageResponse

voice.single_text.post

Send a single text voice message to one recipient

zoomconnect.voice.single_text.post({}, context)

Input

input object
- body WebServiceVoiceMessageSendSingleTextRequest

Output

output WebServiceSendVoiceMessageResponse

voice.messageId.delete

Deletes a message

zoomconnect.voice.messageId.delete({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

Output schema unknown

voice.messageId.get

Returns details for a single message

zoomconnect.voice.messageId.get({
  "messageId": ""
}, context)

Input

input object
- messageId required string: messageId

Output

output WebServiceVoiceMessage

Definitions

Link

Link object
- href string
- rel string
- templated boolean

RestErrorDTO

RestErrorDTO object: RestErrorDTO
- code integer
- developerMessage string
- message string
- moreInfoUrl string
- status string

Void

WebServiceAccount

WebServiceAccount object: WebServiceAccount
- creditBalance number
- links array
  - items Link

WebServiceAccountStatistics

WebServiceAccountStatistics object: WebServiceAccountStatistics
- from string
- grandTotal WebServiceStatistics
- showingCreditValue boolean
- to string
- users array
  - items WebServiceUserStatistics

WebServiceAnalyseMessageRequestMessageAndRecipientNumber

WebServiceAnalyseMessageRequestMessageAndRecipientNumber object: WebServiceAnalyseMessageRequest
- message string
- recipientNumber string

WebServiceAnalyseMessageRequestMessageOnly

WebServiceAnalyseMessageRequestMessageOnly object: WebServiceAnalyseMessageRequest
- message string
- recipientNumber string

WebServiceAnalyseMessageResponse

WebServiceAnalyseMessageResponse object: WebServiceAnalyseMessageResponse
- characterAnalysis array
  - items array
- messageCreditCost number
- messageEncoding string
- messageLength integer
- messageLengthWithinMaximumAllowed boolean
- numberOfMessages integer

WebServiceCampaignStatistics

WebServiceCampaignStatistics object: WebServiceCampaignStatistics
- campaign string
- statistics WebServiceStatistics

WebServiceContact

WebServiceContact object: WebServiceContact
- contactId string
- contactNumber string
- firstName string
- lastName string
- links array
  - items Link
- title string

WebServiceContactLink

WebServiceContactLink object: WebServiceContactLink
- contactId string
- links array
  - items Link

WebServiceContacts

WebServiceContacts object: WebServiceContacts
- links array
  - items Link
- webServiceContacts array
  - items WebServiceContact

WebServiceGroup

WebServiceGroup object: WebServiceGroup
- groupId string
- links array
  - items Link
- name string

WebServiceGroups

WebServiceGroups object: WebServiceGroups
- links array
  - items Link
- webServiceGroups array
  - items WebServiceGroup

WebServiceMessage

WebServiceMessage object: WebServiceMessage
- campaign string
- contact WebServiceContactLink
- creditCost number
- dateTimeReceived string
- dateTimeScheduled string
- dateTimeSent string
- deleted boolean
- fromNumber string
- links array
  - items Link
- message string
- messageId string
- messageStatus string
- messageType string
- numberOfMessages integer
- read boolean
- repliedToMessage WebServiceMessageLink
- toNumber string
- userDataField string

WebServiceMessageLink

WebServiceMessageLink object: WebServiceMessageLink
- links array
  - items Link
- messageId string

WebServiceMessages

WebServiceMessages object: WebServiceMessages
- elements integer
- links array
  - items Link
- page integer
- pageSize integer
- totalElements integer
- totalPages integer
- webServiceMessages array
  - items WebServiceMessage

WebServiceSendSmsRequest

WebServiceSendSmsRequest object: WebServiceSendSmsRequest
- campaign string
- dataField string
- dateToSend string
- message string
- recipientNumber string

WebServiceSendSmsRequests

WebServiceSendSmsRequests object: WebServiceSendSmsRequests
- defaultDateToSend string
- messagesPerMinute integer
- sendSmsRequests array
  - items WebServiceSendSmsRequest

WebServiceSendSmsResponse

WebServiceSendSmsResponse object: WebServiceSendSmsResponse
- error string
- messageId string

WebServiceSendSmsResponses

WebServiceSendSmsResponses object: WebServiceSendSmsResponses
- sendSmsResponses array
  - items WebServiceSendSmsResponse

WebServiceSendVoiceMessageResponse

WebServiceSendVoiceMessageResponse object: WebServiceSendVoiceMessageResponse
- error string
- voiceMessageId string

WebServiceStatistics

WebServiceStatistics object: WebServiceStatistics
- delivered number
- failed number
- failedOptout number
- failedRefunded number
- sent number
- total number

WebServiceTemplate

WebServiceTemplate object: WebServiceTemplate
- data string
- links array
  - items Link
- name string
- templateId integer

WebServiceTemplates

WebServiceTemplates object: WebServiceTemplates
- links array
  - items Link
- webServiceTemplates array
  - items WebServiceTemplate

WebServiceTransferCreditsRequest

WebServiceTransferCreditsRequest object: WebServiceTransferCreditsRequest
- numberOfCreditsToTransfer integer
- transferFromEmailAddress string
- transferToEmailAddress string

WebServiceUser

WebServiceUser object: WebServiceUser
- company string
- contactNumber string
- creditBalance number
- emailAddress string
- firstName string
- lastName string
- password string
- userId integer

WebServiceUserStatistics

WebServiceUserStatistics object: WebServiceUserStatistics
- campaigns array
  - items WebServiceCampaignStatistics
- total WebServiceStatistics
- user WebServiceUser

WebServiceUsers

WebServiceUsers object: WebServiceUsers
- webServiceUserList array
  - items WebServiceUser

WebServiceVoiceMessage

WebServiceVoiceMessage object: WebServiceVoiceMessage
- audioFileUrl string
- campaign string
- dateTimeSent string
- deleted boolean
- language string
- links array
  - items Link
- message string
- messageStatus string
- toNumber string
- userDataField string
- voiceMessageId string

WebServiceVoiceMessageSendSingleTextRequest

WebServiceVoiceMessageSendSingleTextRequest object: WebServiceVoiceMessageSendSingleTextRequest
- campaign string
- dataField string
- language string
- message string
- recipientNumber string
- retryCount integer
- retryMaximumInterval integer
- retryMinimumInterval integer

WebServiceVoiceMessages

WebServiceVoiceMessages object: WebServiceVoiceMessages
- elements integer
- links array
  - items Link
- messages array
  - items WebServiceVoiceMessage
- page integer
- pageSize integer
- totalElements integer
- totalPages integer