4.14.1This function creates a new account.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null body")
object containing account details
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an account data object
This function will create a relationship between two accounts.
(string
= "null access token")
(string
= "null body")
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will delete an account.
(string
= "null access token")
access token for cpaas systems
(string
= "null account uuid")
uuid of account to delete
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will return an account by UUID.
(string
= "null access token")
access token for cpaas systems
(string
= "null account uuid")
account_uuid for an star2star account (customer)
(string?)
expand data in response; currently "identities" or "relationship"
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function returns a list of child accounts for a given CPaaS account uuid.
(string
= "null accessToken")
access token for cpaas system
(string
= "null account uuid")
CPaaS account uuid
(number
= 0)
what page number you want
(number
= 10)
size of the page or number of records to return
(object
= {})
optional filters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of accounts
This function returns all available accounts.
(string
= "null accessToken")
access token for cpaas system
(string
= "null account uuid")
account uuid of the parent
(number
= 0)
what page number you want
(number
= 10)
size of the page or number of records to return
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of accounts
This function returns all available accounts.
(string
= "null accessToken")
access token for cpaas system
(number
= 0)
optional; return the list starting at a specified index
(number
= 10)
optional; return a specified number of accounts
(array
= undefined)
optional array of key-value pairs to filter response.
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of accounts
This function returns a CPaaS user's highest level accounts.
(string
= "null accessToken")
access token for cpaas system
(string
= "null user uuid")
CPaaS user uuid
(number
= 0)
what page number you want
(number
= 10)
size of the page or number of records to return
(object
= {})
optional filters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of accounts
This function will modify an account.
(string
= "null access token")
access token for cpaas systems
(string
= "null account uuid")
(string
= "null body")
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will set an account status to "Active"
(string
= "null access token")
cpaas access token
(string
= "null account uuid")
account uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will set an account status to "Inactive"
(string
= "null access token")
cpaas access token
(string
= "null account uuid")
account uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will get an already created report.
(string
= "null access token")
(any
= "null report uuid")
(string
= "null template uuid")
(object
= {})
optional microservice lifecycle trace headers
(string)
Promise<object>:
Promise resolving to a data object containing new relationship
This function will list available report templates.
(string
= "null access token")
(number
= 0)
pagination offset
(number
= 10)
= pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will create a report based on a template.
(string
= "null access token")
access token for cpaas systems
(string
= "null account uuid")
report template uuid
(string
= undefined)
owner uuid (CPaaS user_uuid) - required if account uuid not specified
(string
= undefined)
CPaaS account uuid - required if owner uuid not specified
(any
= {})
(object
= {})
optional CPaaS microservice lifecycle headers
(object
= {})
report parameters
Promise<object>:
Promise resolving to an object containing report uuid
This function will list registered activity types
(string
= "null access token")
(string
= undefined)
optional include
(number
= 0)
pagination offset
(number
= 10)
= pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will list registered sub activity types
(string
= "null access token")
(string
= undefined)
optional include
(number
= 0)
pagination offset
(number
= 10)
= pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will register an activity type
(string
= "null access token")
(string
= "")
activity type
(number
= 1)
= version
(object
= {})
= schema
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will register a sub activity type
(string
= "null access token")
(string
= "")
activity type
(string
= "")
activity subtype
(number
= 1)
= version
(object
= {})
= schema
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing new relationship
This function will create an activity report template
(string
= "null access token")
(string
= "")
name
(string
= "")
description
(string
= "")
= default view
(object
= {})
= data_source
(array
= [])
= parameters
(array
= [])
= columns
(array
= [])
= limits
(object
= {})
= sort
(array
= [])
= aggregates
(object
= {})
= visualizations
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object
This function will update an activity report template
(string
= "null access token")
(string
= "")
template_uuid
(object
= {})
= template
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object
This function adds resources to a resource group
(string
= "null accessToken")
CPaaS access token
(string
= "null resourceGroup")
uuide of resource group to modify
(array
= "null resources")
array of resource uuids to add to group
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function adds users to a user group
(string
= "null accessToken")
CPaaS access token
(string
= "null userGroupUUID")
user group uuid
(array
= "null members")
array of user uuids
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to the updated user group
This function will assign a permission to a role.
(string
= "null accessToken")
cpaas access token
(string
= "null roleUUID")
role uuid
(object
= "null body")
object containing array of permissions
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function assigns roles to a user-group
(string
= "null accessToken")
cpaas access token
(string
= "null groupUUID")
user-group uuid
(object
= "null body")
object containing an array of roles
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will assign specified access to a resouce for the members of the provided user-group
(string
= "null access token")
cpaas access token
(string
= "null userGroupUUID")
user-group uuid
(string
= "null roleUUID")
role uuid
(string
= "account")
resource or account
(array
= "null data")
array of resource or account uuids to bind to group
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will determine if a user has permission to perform a specified action for a given account
(string
= "null access token")
CPaaS access token
(string
= "null userUUID")
CPaaS user uuid
(string
= "null accountUUID")
CPaaS account uuid
(string
= "null resourceType")
resource type
(array
= "null action")
action to be performed
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will create a resource group for an oauth2 application
(string
= "null accessToken")
cpaas access token
(string
= "null applicationUUID")
(string
= "")
name of resource group
(string
= "")
description of resource group
(array
= [])
array of resource uuids
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a resource group object
This function creates a user-group.
(string
= "null accessToken")
cpaas access token
(any
= "null accountUUID")
(object
= "null body")
user-group object
(object
= {})
optional microservice lifecycle trace headers
(string
= "null account uuid")
account uuid
Promise<object>:
Promise resolving to a user-group data object
This function creates a role.
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
account uuid
(object
= "null body")
role definition object
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a role data object
This function deletes a permission from a role.
(string
= "null accessToken")
cpaas access token
(string
= "null roleUUID")
role uuid
(string
= "null permissionUUID")
permission uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function deletes a role from a user-group.
(string
= "null accessToken")
cpaas access token
(string
= "null userGroupUUID")
user group uuid
(string
= "null roleUUID")
role uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function deletes a role from a user-group.
(string
= "null accessToken")
cpaas access token
(string
= "null userGroupUUID")
user group uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function returns an accounts default user-groups
(string
= "null access token")
access token for cpaas systems
(string
= "null account uuid")
account_uuid for an star2star account (customer)
(object
= {})
optional microservice lifecycle trace headers
Promise:
promise resolving to object containing default admin and user group uuids.
This function returns an oAuth client application default resource groups
(string
= "null accessToken")
CPaaS access token
(string
= "null applicationUUID")
oauth2 client application uuid
(string
= "user")
optional type ["user", "admin", "forbidden"]
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
promise resolving to object containing default resource groups.
This function returns an oAuth client application default user groups
(string
= "null accessToken")
CPaaS access token
(string
= "null applicationUUID")
oauth2 client application uuid
(string
= "user")
optional type ["user", "admin", "forbidden"]
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
promise resolving to object containing default resource groups.
This function returns an oAuth client application resource groups
(string
= "null accessToken")
CPaaS access token
(string
= "null applicationUUID")
oauth2 client application uuid
(object
= {})
optional filters, name, default, etc
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
promise resolving to object containing resource groups.
This function will return the users that have permissions for a given resource
(string
= "null accessToken")
cpaas access token
(string
= "null resourceUUID")
resource uuid
(object
= {})
optional microservice lifecycle headers
Promise<object>:
promise resolving to a users object
This function returns user group members.
(string
= "null accessToken")
cpaas access token
(string
= "null groupUUID")
user group uuid
(string
= "0")
pagination offset
(string
= "10")
pagination limit
(object
= {})
array of filter query string parameters
(boolean
= false)
return all members without pagination
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a role object
This function lists user groups associated with a CPaaS Account.
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
CPaaS account uuid
(string
= "0")
pagination offset
(string
= "10")
pagination limit
(object
= undefined)
array of filter query string parameters (user_uuid, name, sort)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function lists user groups a role is assigned to.
(string
= "null accessToken")
cpaas access token
(string
= "null userGroupUUID")
user group uuid
(array
= undefined)
optional filters. currently supports "name"
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function lists permissions.
(string
= "null accessToken")
(string
= "0")
(string
= "10")
(array
= undefined)
array of filter query parameters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of permissions
This function lists roles a permission is assigned to.
(string
= "null accessToken")
cpaas access token
(string
= "null permissionUUID")
permission uuid
(array
= undefined)
optional filters. currently supports "name"
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function lists user groups a role is assigned to.
(string
= "null accessToken")
cpaas access token
(string
= "null roleUUID")
role uuid
(array
= undefined)
array of filter query parameters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function lists permissions assigned to a role.
(string
= "null accessToken")
cpaas access token
(string
= "null roleUUID")
role uuid
(array
= undefined)
array of filter query parameters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function lists roles.
(string
= "null accessToken")
cpaas access token
(string
= "0")
pagination offset
(string
= "10")
pagination limit
(array
= undefined)
array of filter query parameters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of roles
This function lists roles.
(string
= "null accessToken")
cpaas access token
(string
= "null user_uuid")
user_uuid
(string
= "0")
pagination offset
(string
= "10")
pagination limit
(array
= undefined)
array of filter query parameters
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of roles
This function lists user groups.
(string
= "null accessToken")
cpaas access token
(string
= "0")
pagination offset
(string
= "10")
pagination limit
(array
= undefined)
array of filter query string parameters (user_uuid, name, sort)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of user groups
This function modifies a role
(string
= "null accessToken")
cpaas access token
(string
= "null roleUUID")
uuid of role being modified
(object
= "null body")
object
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a permission data object
This method will change the user-group name and/or description
(string
= "null accessToken")
cpaas access token
(string
= "null groupUuid")
group to modify
(string
= "null body)
object containing new name and/or description
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a group object.
This function removes resources from a resource group
(string
= "null accessToken")
CPaaS access token
(string
= "null resourceGroup")
uuide of resource group to modify
(array
= "null resources")
array of resource uuids to add to group
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function removes users from a user group
(string
= "null accessToken")
CPaaS access token
(string
= "null userGroupUUID")
user group uuid
(array
= "null members")
array of user uuids
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to the updated user group
This function will assign numbers a SMS 10DLC Campaign
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
cpaas account uuid to provision
(string
= "null campaignId")
10dlc campaign id
(array
= [])
array of numbers to assign
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object confirming the assignment of numbers
This function will register a campaign for a CPaaS account that has an active brand registration
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
CPaaS account uuid
(string)
summary description of this campaign between 40 and 4096 characters
(string)
a friendly name for the campaign
(string)
sample message 1
(string)
sample message 2
(string)
sample message 3
(string)
sample message 4
(string)
sample message 5
(boolean)
campaign utilize pool of phone numbers?
(boolean)
messages used for lending or loan arangements?
(boolean)
messages contain embedded URLs?
(boolean)
messages contain embedded phone numbers?
(boolean)
message content controlled by affiliate marketing other than the brand?
(boolean)
campaign includes age gated message content?
(string)
usecase id
(array
= [])
sub usecase ids (strings)
(string
= "Users may opt-in by sending START to any number associated with the campaign. Users may also sign up to receive messages from this campaign via a website after accepting terms and conditions.")
how subscribers are added or opt-in to the campaign
(string)
url for viewing terms and conditions
(string)
url for viewing privacy policy
(boolean
= true)
subscription auto-renews?
(boolean
= true)
provides automated opt-in?
(string
= "START")
opt-in keywords (comma separated)
(string
= "You have replied \"START\" and will begin receiving messages again. Reply \"STOP\" to unsubscribe.")
automated opt-in message
(boolean
= true)
provides automated opt-out?
(string
= "STOP")
opt-out key words (comma separated)
(string
= "You have been unsubscribed from the mailing list and will not receive any more messages. Send \"START\" to resubscribe.")
automated opt-out message
(boolean
= true)
provides automated help?
(string
= "HELP")
help keywords (comma separated)
(string
= "To unsubscribe, reply \"STOP\" to this number. Msg&data rates may apply.")
automated help message
(object
= {})
optional CPaaS lifecycle headers
Promsise<object>:
promise resolving to a brand registration document
This function will create a SMS 10DLC Brand
(string
= "null accessToken")
cpaas access token
(string?
= "null accountUUID")
account uuid to provision on behalf of
(string)
company legal name
(string)
brand name
(string)
organization type
(string
= "US")
registration country
(string)
tax id
(string
= "US")
tax country
(string)
alternate business type
(string)
alternate business id
(string)
business vertical
(string)
legal streed address
(string)
legal address city
(string)
legal address state
(string)
legal address postal code
(string)
company website
(string)
public stock symbol
(string)
public stock exchange
(string)
contact email address
(any)
(string)
contact phone number
(string)
contact first name
(string)
contact last name
(object
= {})
microservice lifecyce headers
(string)
business contact email address
Promise:
Promise resolving to a object containing a new 10DLC Brand
This function will delete a SMS 10DLC Brand
(string
= "null accessToken")
cpaas access token
(string?)
account uuid to provision on behalf of
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object confirming the delete request was received
This function will delete a campaign from a SMS 10DLC Brand / CPaaS account
(string
= "null accessToken")
cpaas access token
(string?)
CPaaS account uuid
(string
= "null campaignId")
10DLC campaign id to retrieve
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing a CPaaS account 10DLC brand registrations
This function will get a SMS 10DLC Brand
(string
= "null accessToken")
cpaas access token
(string?)
account uuid to provision on behalf of
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing a CPaaS account 10DLC brand registrations
This function will get campaign options for a SMS 10DLC Brand
(string
= "null accessToken")
cpaas access token
(string?)
account uuid to provision on behalf of
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing a CPaaS account 10DLC brand registrations
This function will get a campaign for a SMS 10DLC Brand / CPaaS account
(string
= "null accessToken")
cpaas access token
(string?)
CPaaS account uuid
(string
= "null campaignId")
10DLC campaign id to retrieve
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing a CPaaS account 10DLC brand registrations
This function will deprovision numbers from a CPaaS account and/or user
(string
= "null accessToken")
cpaas access token
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing deprovisioning confirmation details
This function will list campaigns for a SMS 10DLC Brand / CPaaS account
(string
= "null accessToken")
cpaas access token
(string?)
CPaaS account uuid
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing a CPaaS account 10DLC brand registrations
This function will remove numbers a SMS 10DLC Campaign
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
cpaas account uuid to provision
(string
= "null campaignId")
10dlc campaign id
(array
= [])
array of numbers to assign
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object confirming the removal of numbers
This function will update (re-register) a campaign for a CPaaS account that has an active brand registration
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
CPaaS account uuid
(string
= "null campaignId")
10DLC campaign id to update
(string)
summary description of this campaign between 40 and 4096 characters
(string)
a friendly name for the campaign
(string)
sample message 1
(string)
sample message 2
(string)
sample message 3
(string)
sample message 4
(string)
sample message 5
(boolean)
campaign utilize pool of phone numbers?
(boolean)
messages used for lending or loan arangements?
(boolean)
messages contain embedded URLs?
(boolean)
messages contain embedded phone numbers?
(boolean)
message content controlled by affiliate marketing other than the brand?
(boolean)
campaign includes age gated message content?
(string)
usecase id
(array)
sub usecase ids (strings)
(string
= "Users may opt-in by sending START to any number associated with the campaign. Users may also sign up to receive messages from this campaign via a website after accepting terms and conditions.")
how subscribers are added or opt-in to the campaign
(string)
url for viewing terms and conditions
(string)
url for viewing privacy policy
(boolean
= true)
subscription auto-renews?
(boolean
= true)
provides automated opt-in?
(string
= "START")
opt-in keywords (comma separated)
(string
= "You are now opted-in.\n\nFor help, reply HELP.\n\nTo opt-out, reply STOP")
automated opt-in message
(boolean
= true)
provides automated opt-out?
(string
= "STOP")
opt-out key words (comma separated)
(string
= "You have successfully opted-out.\n\nYou will not receive any more messages from this number.\n\nYou may reply START at any time to opt-in again.")
automated opt-out message
(boolean
= true)
provides automated help?
(string
= "HELP")
help keywords (comma separated)
(string
= "To opt-in and receive messages from this number, reply START.\n\nFor help, reply HELP.\n\nTo opt-out at any time, reply STOP")
automated help message
(object
= {})
optional CPaaS lifecycle headers
Promsise<object>:
promise resolving to a brand registration document
This function will add a member to a channel.
(string
= "null access_token")
access_token for cpaas system
(string
= "no channel uuid specified")
channel uuid
(object)
object {"uuid": "string","type": "string"}
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a member data object
This function will create a new channel.
(string
= "null access token")
access_token for cpaas systems
(string
= "null user uuid")
user UUID to be used
(string
= "no name specified for group")
name
(string
= "no topic specified")
topic
(string
= undefined)
description
(string
= undefined)
group UUID for members
(string
= undefined)
account uuid
(object
= {})
object for meta data
(string
= undefined)
type
(string
= undefined)
parent uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will delete a member from channel.
(string
= "null access_token")
access_token for cpaas systems
(string
= "no channel uuid specified")
member to remove
(string
= "empty")
member to remove
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a member data object
This function will get channel messages.
(string
= "null access_token")
access_token for cpaas systems
(string
= "no channel uuid specified")
channel uuid
(number
= 100)
number of messages
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a colelction of message objects.
This function will get a specific Channel.
(string
= "null access token")
access token for cpaas systems
(string
= "no Channel uuid specified")
Channel UUID
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will get channel info, messages, and members.
(string
= "null access_token")
access_token for cpaas systems
(string
= "no channel uuid specified")
string message
(number
= 100)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will return a list of channel members.
(string
= "null access_token")
(string
= "no channel uuid specified")
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will list Channels.
(string
= "null acess token")
access token for cpaas systems
(object
= undefined)
optional object,
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will send a message to a chat channel
(string
= "null accessToken")
CPaaS access token
(string
= "null userUUID")
user uuid
(string
= "null accountUUID")
account uuid
(string
= 0)
pagination offset
(string
= 10)
pagination limit
(object
= {})
optional CPaaS request lifecycle headers
Promise<object>:
promise resolving to a list of channel objects
This function will send a message to a chat channel
(string
= "null accessToken")
CPaaS access token
(string
= "null channelUUID")
channel uuid
(object
= {})
optional CPaaS request lifecycle headers
Promise<object>:
promise resolving to a message confirmation object
This function will update channel info
(string
= "null access_token")
(string
= "no channel uuid specified")
(object
= {})
object containing attributes to update
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will udpate channel meta
(string
= "null access_token")
access_token for cpaas systems
(string
= "no channel uuid specified")
channel uuid
(object
= {})
metedata object
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will ask the cpaas contacts service to create a contact.
(string
= "null accessToken")
access token
(string
= "null user uuid")
user UUID to be used
(any
= {})
contact data object
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a contact data object
This function will ask the cpaas contacts service to delete a contact
(string
= "null accessToken")
access token
(string
= "null contact uuid")
contact UUID to be used
(object
= {})
optional microservice lifecycle trace headers
Promise:
Promise resolving to a data object
This function return a single contact by uuid
(string
= "null access_token")
cpaas access token
(string
= "null contact_uuid")
contact uuid
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
promise resolving to a contact object
This function will list a user's contacts
(string
= "null access_token")
cpaas access token
(string
= "null user_uuid")
user uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= {})
optional filters or search params
(object
= {})
optional microservice lifecycle headers
This function will update a contact
(string
= "null access_token")
cpaas access token
(string
= "null contactUUID")
contact uuid
(string
= "null body")
contact data (PUT)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to updated contact data
This function will send an email to the provided recipients
(any
= "null accessToken")
(string
= "")
email address of sender
(object
= [])
array of email addresses for recipients; also can be object with arrays "to", "bcc", "cc"
(string
= "")
message subject
(string
= "")
mesaage
(string
= "text")
//TODO add validation for types
(object
= {})
optional microservice lifecycle trace headers
This function will send an email to the provided recipients
(any
= "null accessToken")
(string
= "")
email address of sender
(object
= [])
array of email addresses for recipients; also can be object with arrays "to", "bcc", "cc"
(string
= "")
message subject
(string
= "")
mesaage
(string
= "text")
//TODO add validation for types
(object
= [])
array of objects for attachments
(object
= {})
optional microservice lifecycle trace headers
This fuction will activate a pending async entitlement
(string
= "null accessToken")
CPaaS access token
(string
= "null userUUID")
CPaaS user uuid
(object
= "null entitlementUUID")
entitlement uuid
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an acknowledgement of the entitlement being activated
This fuction will remove multiple entitlements with one request
(string
= "null accessToken")
CPaaS access token
(array
= [])
array of entitlement uuids
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an acknowledgement of the entitlement being activated
This fuction will entitle multiple users with one request
(string
= "null accessToken")
CPaaS access token
(array<Entitlement>
= [])
array of user entitlement entitlement objects
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an acknowledgement of the entitlement being activated
This fuction prevents entitlement of a product at an account level
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
account uuid
(string
= "null productUUID")
product uuid to disable
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an object confirming product is disabled
This fuction prevents entitlement of a product type at an account level
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
account uuid
(string
= "null productType")
product type to disable
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an object confirming product is disabled
This fuction enables entitlement of a product at an account level
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
account uuid
(string
= "null productUUID")
product uuid to enable
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an object confirming product is disabled
This fuction enables entitlement of a product type at an account level
(string
= "null accessToken")
CPaaS access token
(string
= "null accountUUID")
account uuid
(string
= "null productType")
product type to enable
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to an object confirming product is disabled
This function returns a single entitlement product
(string
= "null accessToken")
CPaaS access token
(string
= "null productUUID")
product UUID
(object
= {})
option CPaaS lifecycle headers
Promise<object>:
Promise resolving to a product object
This fuction returns a product by application uuid
(string
= "null accessToken")
CPaaS access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of products
This fuction returns a list of products
(string
= "null accessToken")
CPaaS access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of products
This fuction returns a list of user entitlements
(string
= "null accessToken")
CPaaS access token
(string
= "null")
User uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of user entitlements
This fuction returns a list of user entitlements. This is new an improved uses query for filters.
(string
= "null accessToken")
CPaaS access token
(string
= "null")
User uuid
(number
= 0)
pagination offset
(number
= 20)
pagination limit
(object
= {}})
optional filters object {"key": "value"}
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of user entitlements
This fuction returns a list of disabled products by account
(string
= "null accessToken")
CPaaS access token
(string
= "null")
account uuid
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(boolean
= false)
return all matching values for client side pagination
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of user entitlements
This fuction returns a list of entitlements by account
(string
= "null accessToken")
CPaaS access token
(string
= "null")
account uuid
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(boolean
= false)
return all matching values for client side pagination
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of user entitlements
This fuction returns a list of disabled product types by account
(string
= "null accessToken")
CPaaS access token
(string
= "null")
account uuid
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(object
= undefined)
optional filters object {"key": "value"}
(boolean
= false)
return all matching values for client side pagination
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving to a list of user entitlements
This fuction will update a product specified
(string
= "null accessToken")
CPaaS access token
(string
= "null")
product uuid
(object
= undefined)
the product object
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
Promise resolving the updated product
This function will create a form instance from a form template uuid
(string
= "null access token")
CPaaS access toke
(string
= "null account uuid")
account uuid
(string
= "active")
active or inactive
(string
= "no name")
instance name
(date
= undefined)
optional due date
(string?
= undefined)
optional application uuid
(boolean
= true)
allow unauthenticated submission
(boolean
= true)
allow submission to be updated
(string
= "null template uuid")
form template uuid
(object
= undefined)
option metadata in JSON
(object
= {})
optional CPaaS lifecycle headers
Promise:
This function will create a form template
(string
= "null access token")
CPaaS access toke
(string
= "no name")
instance name
(string
= "")
description
(string
= "null account uuid")
account uuid
(object
= undefined)
form definition - formio
(object
= {})
optional CPaaS lifecycle headers
Promise:
This function will delete the form instance
(string
= "null access token")
access token for cpaas systems
(string
= "null form uuid")
uuid of form instance to delete
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will delete the form template
(string
= "null access token")
access token for cpaas systems
(string
= "null template uuid")
uuid of template to delete
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a status data object
This function will GET a form instance
(string
= "null access token")
CPaaS access token
(string
= "null form instance uuid")
form instance uuid
(string
= undefined)
option include ["metadata", "form_definition"]
(object
= {})
optional CPaaS lifecycle headers
Promise:
This function will GET a form template
(string
= "null access token")
CPaaS access token
(string
= "null template uuid")
form template uuid to look up
(string
= false)
include form definition in response
(object
= {})
optional CPaaS lifecycle headers
Promise:
This function will GET a form template
(string
= "null access token")
CPaaS access token
(string
= undefined)
optional account uuid
(any
= 0)
(any
= 10)
(object
= {})
optional CPaaS lifecycle headers
(string
= "null template uuid")
form template uuid to look up
Promise:
This function list user forms.
(string
= "null access token")
cpaas access token
(string
= "null account uuid")
account_uuid for an star2star account (customer)
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(object
= undefined)
optional filter options
Promise:
This function list user form submissions.
(string
= "null access token")
cpaas access token
(string
= "null account uuid")
account_uuid for an star2star account (customer)
(string
= "null")
form uuid
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(object
= undefined)
optional filter options
Promise:
This function will create a form template
(string
= "null access token")
CPaaS access toke
(any
= "no form template uuid")
(object
= undefined)
form definition - formio
(object
= {})
optional CPaaS lifecycle headers
(string
= "no name")
instance name
(string
= "")
description
(string
= "null account uuid")
account uuid
Promise:
This function will add users to a user group.
(string
= "null accessToken")
access Token
(string
= "group uuid not specified")
data object UUID
(array
= [])
array of objects containing 'uuid' (for known users)
(object
= {})
optional microservice lifecycle trace headers
Promise<array>:
Promise resolving to an array of added users
This method will deactivate a group
(string
= "null accessToken")
cpaas access token
(string
= "null groupUuid")
group to modify
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a group object.
This function will remove one or more members from a group
(string
= "null accessToken")
cpaas access token
(string
= "null groupUUID")
group to remove users from
(array
= [])
array of objects containing 'uuid' (for known users)
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure status object.
This function will ask the cpaas groups service for a specific group.
(string
= "null accessToken")
access Token
(string
= "null uuid")
group UUID
(array
= undefined)
optional array of filters, e.g. [expand] = "members.type"
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a single group
This function will return the groups associated with a user
(string
= "null accessToken")
cpaas access otken
(number
= 0)
page number
(number
= 10)
page size
(array
= undefined)
optional array of key-value pairs to filter response.
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a list of user groups.
This function will return a list of the members of a group.
(string
= "null accessToken")
access Token
(string
= "null uuid")
group UUID
(array
= undefined)
optional array of filters, e.g. [expand] = "members.type", [offset] and [limit] for pagination
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a single group
This method will change the group name and description
(string
= "null accessToken")
cpaas access token
(string
= "null groupUuid")
group to modify
(string
= "null body)
object containing new name and/or description
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a group object.
This method will reactivate a group
(string
= "null accessToken")
cpaas access token
(string
= "null groupUuid")
group to modify
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a group object.
This function will add aliases to an identity
(string
= "null accessToken")
access token
(string
= "null user uuid")
user_uuid for alias being created
(object
= "null body")
object containing any combination of email, nickname, or sms alias assignments.
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object with alias
This function will call the identity microservice with the credentials and accessToken you passed in.
(string
= "null accessToken")
access token
(string
= "null accountUUID")
account uuid
(object
= "null body")
JSON object containing new user info
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will delete an account password policy.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null accountUUID")
password reset token received via email
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object confirming success or failure
This function will call the identity microservice with the credentials and accessToken you passed in and delete the user object matching the user_uuid submitted.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null uuid")
uuid for a star2star user
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will delete an SMS number from the identity MFA
(string
= "null accessToken")
access token for cpaas systems
(string
= "null userUUID")
user uuid
(string
= "null source")
SMS number to be deleted from MFA
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object confirming success or failure
This function will initiate a request for a password reset token via the user email account.
(string
= "null access token")
access token for cpaas systems
(string
= "null emailAddress")
target email address
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a as status message; "ok" or "failed"
This function will get an account's current MFA policy.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null accountUUID")
password reset token received via email
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing the account MFA policy
This function will get an account's current password policy.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null accountUUID")
password reset token received via email
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing the current account password policy
This function returns a single identity object
(string
= "null accessToken")
cpaas access token
(string
= "null uuid")
user uuid
(object
= {})
optional microservice lifcycle headers
(string
= undefined)
optional query param -"properties" and "alias" are valid values
Promise:
promise resolving to identity object
This function will call the identity microservice with the credentials and accessToken you passed in.
(string
= "null access token")
access token for cpaas systems
(string
= "null user uuid")
user uuid to lookup
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function returns array of MFA email/SMS and their active status for use in multifactor auth
(string
= "null accessToken")
cpaas access token
(string
= "null uuid")
user uuid
(number
= 0)
list offset
(number
= 10)
number of items to return
(any
= {})
(any
= undefined)
Promise:
promise resolving to identity MFA response object containing array of MFA settings
This function will return the identity data for the authenticated user.
(string
= "null access token")
access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will list the identities associated with a given account.
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
account uuid
(number
= 0)
list offset
(number
= 10)
number of items to return
(array
= undefined)
optional array of key-value pairs to filter response.
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will list the identities associated with a given account.
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
account uuid
(number
= 0)
list offset
(number
= 10)
number of items to return
(array
= undefined)
optional array of key-value pairs to filter response using or condition on fliters.
(boolean
= false)
retrieves all results for client side search or pagination
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will the available password policies.
(string
= "null accessToken")
access token for cpaas systems
(string?)
optional include, include=rules
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a list of CPaaS IDP password policies
This function will call the identity microservice with the credentials and accessToken you passed in.
(string
= "null access token")
access token for cpaas systems
(string
= "null email")
email address for an star2star account
(string
= "null pwd")
passowrd for that account
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will look up an identity by username.
(string
= "null accessToken")
(number
= 0)
list offset
(number
= 10)
number of items to return
(array
= undefined)
optional array of key-value pairs to filter response.
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function will allow you to modify all details of identity except account_uuid, username and external_id, password and provider.
(string
= "null accessToken")
(string
= "null userUuid")
(object
= "null body")
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object
This function updates properties of an identity
(string
= "null accessToken")
cpaas access token
(string
= "null userUuid")
user uuid
(object
= "null body")
property body
(object
= {})
optional microservice lifecycle headers
Promise:
return a promise containing the updataded idenity
This function will update a user's password. This is part of the 'forgot password' flow.
(string
= "null access token")
access token for cpaas systems
(any
= "null passwordToken")
(object
= "null body")
object containing email address and new password
(object
= {})
optional microservice lifecycle trace headers
(string
= "null passwordToken")
Reset token received via email
Promise<object>:
Promise resolving to a as status message; "ok" or "failed"
This function will call the identity microservice with the credentials and accessToken you passed in.
(string
= "null accessToken")
access token
(string
= "null user uuid")
user_uuid for alias being created
(string
= "null DID")
sms number to associate with the user
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an identity data object with alias
This function will update an account's MFA policy.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null accountUUID")
password reset token received via email
(array?
= [])
array of mfa options to enable for the account
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing the new account MFA policy
This function will update an account's password policy.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null accountUUID")
password reset token received via email
(string
= "null policy uuid")
CPaaS password policy uuid
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing the new account password policy
This function will update a user's MFA settings.
(string
= "null accessToken")
access token for cpaas systems
(any
= "null password token")
(string
= undefined)
"EMAIL" or "SMS"
(boolean
= false)
true or false
(string
= undefined)
email address or SMS number
(object
= {})
optional microservice lifecycle trace headers
(string
= "null uuid")
user uuid
Promise<object>:
Promise resolving to an object containing the new account MFA policy
This function will validate a password reset token received from email.
(string
= "null access token")
access token for cpaas systems
(string
= "null password token")
password reset token received via email
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object confirming the token and target email
This function gets the configured microservice host variable.
string:
configured host URL
This function sets the microservice target host (MS_HOST) variable.
(string
= "https://cpaas-api.star2star.com")
valid url for microservice host server
This function lists lambdas
(string
= 'null access Token')
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will ask the cpaas data object service for a specific object.
(string
= 'null access Token')
access Token for cpaas systems
(string
= 'not defined')
string representing the lambda name
(object
= {})
json object of parameters to be passed to the lambda function
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will ask the cpaas media service to delete a specific user file.
(string
= "no file_id provided")
File ID
(string
= "null accessToken")
Access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will return media file metadata including a URL
(string
= "null accessToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(date)
UTC format start date
(date)
UTC format end date
(string)
column sort
(boolean)
included flagged deleted
(string)
file category to search for
(string)
search by file_name, file_title, or description
(boolean)
include refs to thumbnail versions
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to list or global media objects
This function will return media file metadata including a URL
(string
= "null accessToken")
cpaas access token
(string
= "null fileUUID")
file UUID
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(number
= undefined)
expiry of url in milliseconds
Promise<object>:
Promise resolving to a data object containing file meta-data
This function will ask the cpaas media service for the list of user's files they have uploaded.
(string
= "no user uuid provided")
UUID for user
(string
= "null accessToken")
Access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of groups for this user
This function will ask the cpaas media service to delete a specific user file.
(string
= "null accessToken")
Access token for cpaas systems
(string
= "no file_id provided")
File ID
(string
= "invalid user uuid")
user uuid to share with
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will upload a file to the cpaas media service for the user.
(string
= Date.now())
File name.
(formData)
File to be uploaded
(string
= "not specified user uuid ")
(string
= "null accessToken")
Access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing upload attributes.
This function will upload a file to the cpaas media service for global use.
(string
= Date.now())
File name.
(formData)
File to be uploaded
(string
= "null accessToken")
Access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing upload attributes.
This function deletes (archives for 30 days) a specific conversation
(string
= "null accessToken")
cpaas application token
(string
= "null conversation_uuid")
conversation uuid
(object
= {})
options microservice lifecycle tracking headers
Promise<empty>:
Promise resolving success or failure.
This function deletes (archives for 30 days) multiple conversations
(string
= "null accessToken")
cpaas application token
(array
= [])
array of objects containing 'conversation_uuid'
(object
= {})
options microservice lifecycle tracking headers
Promise<empty>:
Promise resolving success or failure status object.
This function deletes a specific message
(string
= "null accessToken")
cpaas application token
(string
= "null message_uuid")
message uuid
(object
= {})
options microservice lifecycle tracking headers
Promise<empty>:
Promise resolving success or failure.
This function deletes multiple messages
(string
= "null accessToken")
cpaas application token
(array
= [])
array of strings containing 'message_uuid'
(object
= {})
options microservice lifecycle tracking headers
Promise<empty>:
Promise resolving success or failure status object.
This function creates a new conversation and returns metadata.
(string
= "null accessToken")
cpaas application token
(string
= "null userUuid")
user uuid
(string
= "null toPhoneNumber")
Destination phone number for the conversation
(object
= {})
options microservice lifecycle tracking headers
Promise<object>:
A promise resolving to a conversation metadata object
This function will retrieve the conversation uuid for whom you are sending it to.
(string)
Access token for cpaas systems
(string)
The user uuid making the request
(string)
A full phone number you will be sending the sms too
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a conversation uuid data object
This function will get user sms number.
(string)
cpaas access Token
(string)
the user uuid making the request
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing the sms number
This function will mark all conversations read
(string
= "null accessToken")
cpaas access token
(string
= "null conversationUUID")
conversation uuid
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a modified conversation object
This function will retrieve a conversation
(string
= "null accessToken")
cpaas application token
(string
= "null userUuid")
conversation uuid
(object
= {})
optional filter object ... status
(object
= {})
options microservice lifecycle tracking headers
Promise<object>:
A promise resolving to a conversation metadata object
(string
= "null accessToken")
cpaas access token
(string
= "null userUUID")
user uuid
(number
= 0)
pagination offest
(number
= 10)
pagination limit
(array
= undefined)
optional filters. currently supports "snooze"
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to user conversations
This function returns message history
(string
= "null accessToken")
cpaas access token
(string
= "null conversationUUID")
conversation uuid
(number
= 0)
pagination offset
(number
= 100)
pagination limit
(string
= "-datetime")
sort by column (default "-datetime")
(object
= {})
microservice lifecycle headers
Promise<object>:
Promise resolving to to a message history object.
This function will post a message to a channel.
(string
= "null access_token")
access_token for cpaas systems
(string
= "null user uuid")
user UUID to be used
(string
= "no channel uuid specified")
channel uuid
(string
= "missing text")
message
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will send messages in multiple formats
(string
= "null accessToken")
cpaas access token
(string
= "null userUUID")
user uuid
(string
= "null conversationUUID")
conversation uuid
(string
= "null fromPhoneNumber")
sender phone number
(string
= "sms")
channel (sms or mms)
(array
= [])
array of content objects
(object
= {})
optional microservice lifecycle headers
Promise<object>:
promise resolving to a message confirmation object
This function sends a basic SMS message without using the messaging API
(any
= "null access token")
(string
= "null sender")
sender number (+15555555555)
(string
= "null receiver")
recipient number (+15555555555)
(string
= "null message")
message
(type
= "text")
message type
(object
= {})
optional metadata object
(object
= {})
optional microservice lifecycle trace headers
(any)
any:
Promise resolving to sms send confirmation with uuid
This function will send an sms message.
(string)
cpaas access Token
(string)
the user uuid making the request
(string)
the message to send
(string)
full phone number to use as the sender/reply too
(string)
full phone number you will be sending the sms too
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a response confirmation data object
This function will send an sms message.
(string)
cpaas access Token
(string)
uuid of conversation; see getConvesationUUID
(string)
the user uuid making the request
(string)
full phone number to use as the sender/reply too
(string)
the message to send
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a response confirmation data object
This function will snooze/un-snooze conversations
(string
= "null accessToken")
cpaas access token
(string
= "null conversationUUID")
conversation uuid
(boolean
= "false snooze")
snooze:true OR snooze:false to either snooze / un-snooze
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a modified conversation object
This function will archive/un-archive conversations
(string
= "null accessToken")
cpaas access token
(string
= "null conversationUUID")
conversation uuid
(boolean
= false)
archived:true OR archived:false to either archived / un-archived
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to empty because 204 no content
This function will return metadata for all API's or a subset of API's
(string
= "null access token")
cpaas access token
(string
= "")
empty or comma-separated list of requested subsystems
(object
= {})
optional cpaas lifecycle headers
Promise:
This function will return a list of push notification registrations by user uuid
(string
= "null accessToken")
cpaas access token
(string
= "null fileUUID")
user UUID
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing user push notification registrations
This function will ask the cpaas media service for the list of user's files they have uploaded.
(string
= "null accessToken")
Access token for cpaas systems
(string
= "no user uuid provided")
UUID for user
(any
= "no device uuid provided")
(string
= "no push token provided")
(string
= "no application provided")
(string
= "no platform provided")
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
promise resolving to registration object
This function will send a push notification to a mobile device
(string
= "null accessToken")
CPaaS access token
(string
= "no application provided")
target application
(array
= "no user uuid provided")
array of device_ids to send notification to
(any
= "no deviceIDs array provided")
(string
= undefined)
notification title
(string
= undefined)
notification messge
(object
= undefined)
optional additiona data to accompany the message text as payload
(object
= undefined)
optional platform (ios/android) specific payload data
(object
= {})
optional CPaaS lifecycle headers
Promise<object>:
promise resolving to a push notification object
This function will ask the cpaas media service for the list of user's files they have uploaded.
(string
= "null accessToken")
Access token for cpaas systems
(string
= "no push token provided")
(any
= {})
Promise<object>:
promise resolving to success or failure
This function will deprovision numbers from a CPaaS account and/or user
(string
= "null accessToken")
cpaas access token
(array
= [])
array of numbers to provision
(string
= "VI")
optional number provider to associate with
(string?)
optional account uuid to provision on behalf of
(string?)
optional user uuid to provision on behalf of
(string?)
optional country code to use to format and validate the provided numbers, defaults to "US"
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing deprovisioning confirmation details
This function will list area codes with available numbers base on state and rate center
(string
= "null accessToken")
cpaas access token
(string?)
US state
(any)
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a list of available DIDs
This function will list rate centers with available numbers based on the state
(string
= "null accessToken")
cpaas access token
(string?)
US state
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a list of available DIDs
This function will list numbers provisioned to a CPaaS account
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
cpaas account_uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= {})
optional filters
(boolean
= false)
aggregate from the api for client side filtering and pagination
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a list of available DIDs
This function will list numbers provisioned to a CPaaS user
(string
= "null accessToken")
cpaas access token
(string
= "null userUUID")
cpaas user_uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a list of available DIDs
This function will list numbers available for purchase
(string
= "null accessToken")
cpaas access token
(number
= 5)
number of DIDs to return
(number
= 1)
price tier (1-4, 4 being most expensive)
(string
= "VI")
telephony network
(string?)
2 letter US state code
(string?)
town or population center name
(number?)
npa or area code
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a list of available DIDs
This function will provision numbers to a CPaaS account and/or user
(string
= "null accessToken")
cpaas access token
(array
= [])
array of numbers to provision
(string
= "VI")
optional number provider to associate with
(string?)
optional account uuid to provision on behalf of
(string?)
optional user uuid to provision on behalf of
(string?)
optional help message for automated sms responses
(boolean?)
optional sms campaign number, defaults to true
(string?)
optional reference id
(string?)
optional country code to use to format and validate the provided numbers, defaults to "US"
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing provisioning confirmation details
This function will update the automated help message for the provided numbers
(string
= "null accessToken")
cpaas access token
(array
= [])
array of numbers to provision
(string?)
help message for automated sms responses
(string?)
optional country code to use to format and validate the provided numbers, defaults to "US"
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing provisioning confirmation details
This function will update the reference id for the provided numbers
(string
= "null accessToken")
cpaas access token
(array
= [])
array of numbers to provision
(string?)
reference id
(string?)
reference text
(string?)
optional country code to use to format and validate the provided numbers, defaults to "US"
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to a object containing provisioning confirmation details
This function will restrict the client token to specific microservices
(string
= "null accessToken")
cpaas access token
(string
= "null clientUUID")
client uuid (obtained when creating using createClientApp()
(string
= "null policyUUID")
policy uuid
(object
= {})
optional trace headers for debugging.
Promise:
promise resolving to a request status message.
This function creates a client for a provided user uuid.
(string
= "null access token")
cpaas access token
(string
= "null userUUID")
user uuid
(string
= "null name")
client name
(string
= "null description")
client description
(object
= {})
optional trace headers for debugging
Promise:
promise resolving to a client object
This function will call the oauth microservice with the credentials and outh key and basic token you passed in.
(string
= "null oauth token")
token for authentication to cpaas oauth system
(string
= "null email")
email address for a star2star account
(string
= "null pwd")
password for that account
(string
= "default")
access token scopes
(string
= undefined)
unique identifier
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an oauth token data object
This function will call the oauth microservice with the basic token you passed in.
(string
= "null basic token")
token for authentication to cpaas oauth system
(object
= {})
optional microservice lifecycle trace headers
(any
= "default")
Promise<object>:
Promise resolving to an oauth token data object
This function will return active access tokens based on the filters provided
(string
= "null accessToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
token_type and username or client_id depending on token type
(object
= {})
optional trace headers for debugging
Promise:
promise resolving to a list of access tokens.
This function returns a list of oauth2 clients
(string
= "null accessToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
query param key value pairs
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
Promise resolving to a list of oauth2 clients
This function will call the identity microservice to refresh user based on token.
(string
= "null oauth token")
token for authentication to cpaas oauth system
(string
= "null refresh token")
refresh token for oauth token.
(object
= {})
optional microservice lifecycle trace headers
(string
= "null oauth key")
key for oauth cpaas system
Promise<object>:
Promise resolving to an identity data object
This function will restrict the client token to specific microservices
(string
= "null accessToken")
cpaas access token
(string
= "null clientUUID")
client uuid (obtained when creating using createClientApp()
(string
= ["default"])
array of microservices the token should be able to access
(object
= {})
optional trace headers for debugging.
Promise:
promise resolving to a request status message.
This function will create a new account data object.
(string
= "null user uuid")
user UUID to be used
(string
= "null accessToken")
Access Token
(string)
object name
(string)
object type (use '_' between words)
(string)
object description
(object
= {})
object to be created
(string
= "null accountUUID")
optional account uuid to scope user permissions
(object
= {})
microservice lifecycle trace headers
(object
= {})
metadata obj
Promise<object>:
Promise resolving to a data object
This function will create a new data object.
(string
= "null accessToken")
Access Token
(string)
string object name
(string)
string object type (use '_' between words)
(string)
string object description
(object
= {})
object with contents
(object
= {})
microservice lifecycle trace headers
(object
= {})
metadata obj
Promise<object>:
Promise resolving to a data object
This function will create a new user data object.
(string
= "null user uuid")
user UUID to be used
(string
= "null accessToken")
Access Token
(string)
object name
(string)
object type (use '_' between words)
(string)
object description
(object
= {})
object to be created
(string
= "null accountUUID")
optional account uuid to scope user permissions
(object
= undefined)
optional object containing users for creating permissions groups
(object
= {})
microservice lifecycle trace headers
(object
= {})
metadata obj
Promise<object>:
Promise resolving to a data object
This function will delete a data object and any resource groups associated with that object.
(string
= "null accessToken")
accessToken
(string
= "not specified")
data object UUID
(object
= {})
microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function will ask the cpaas data object service for a specific type of object.
(string
= "null accessToken")
Access Token
(string
= "data_object")
Data object type to be retrieved; default: dataObjectType
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(boolean?
= "false")
String boolean if the call should also return content of object; default false
(object
= {})
microservice lifecycle trace headers
Promise<array>:
Promise resolving to an array of data objects
This function will ask the cpaas data object service for a specific object.
(string
= "null accessToken")
Access Token
(string
= "null uuid")
data object UUID
(object
= {})
microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function returns objects permitted to user with flexible filtering.
(string
= "null accessToken")
(string
= "null userUUID")
(number
= 0)
pagination limit
(number
= 10)
pagination offset
(any
= false)
(array
= undefined)
array of filter options [name, description, status, etc]
(object
= {})
microservice lifecycle trace headers
(boolean
= false)
return object content or just descriptors
Promise:
Promise resolving to a list of objects
This function will ask the cpaas data object service for a specific type of object.
(string
= "null user uuid")
user UUID to be used
(string
= "null accessToken")
Access Token
(string
= "data_object")
Data object type to be retrieved; default: dataObjectType
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(boolean?
= "false")
String boolean if the call should also return content of object; default false
(object
= {})
microservice lifecycle trace headers
Promise<array>:
Promise resolving to an array of data objects
This function will ask the cpaas data object service for a specific type of object with name.
(string
= "null user uuid")
user UUID to be used
(string
= "null accessToken")
Access Token
(string
= "data_object")
Data object type to be retrieved; default: dataObjectType
(any
= "noName")
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(boolean?
= "false")
String boolean if the call should also return content of object; default false
(object
= {})
microservice lifecycle trace headers
Promise<array>:
Promise resolving to an array of data objects
This function will update an existing data object.
(string
= "null accessToken")
Access Token
(string
= "uuid not specified")
data object UUID
(object
= {})
data object replacement
(string
= undefined)
optional account to scope users object permissions to
(object
= undefined)
optional users permissions object
(object
= {})
microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object
This function create a user profile property
(string
= "null accessToken")
CPaaS access token
(string
= "null userUUID")
CPaaS user uuid
(string
= "no_property_name")
property name
(string
= "no_property_value")
property value
(string
= undefined)
optional property label will default to name
(string
= undefined)
optional property description will default to name
(object
= {})
optional CPaaS lifecycle headers
This function updates a user profile property
This function will create a token provider for the given user and service
(string
= "null clientID")
Star2Star's clientID assigned by third party
(string
= "null providerUUID")
provider API policy uuid
(string
= "null redirectURL")
auth code redirect URL
(string
= "null userUUID")
CPaaS user uuid
(object
= {})
optional CPaaS lifecycle headers
This function will redirect the caller to complete oauth2 authorization and redirect the response with access_token to specified URL
(string
= "null accessToken")
CPaaS access token
(string
= "null providerUUID")
Oauth2 provider identifier
(string
= "null policyUUID")
cpaas provider API policy id used to generate access token
(string)
optional cpaas user uuid. only required if the access_token does not belong to the cpaas user
(string)
optional completed request redirect URL
(string)
optional 3rd party user name for CPaaS identities with multiple connections for the same provider
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
Promise resolving to oauth2 provider access token
This function will return a refreshed access token for the associated provider
(string
= "null accessToken")
CPaaS access token
(string
= "null connectionUUID")
provider API connection uuid
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
Promise resolving to oauth2 provider access token
This function will list all the providers of a given user
(string
= "null accessToken")
CPaaS access token
(string
= "null userUUID")
CPaas user uuid
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
Promise resolving to oauth2 provider access token
This function will list 3rd party oauth2 connections/authorizations.
(string
= "null accessToken")
CPaaS access token
(string
= "null userUUID")
CPaas user uuid
(string
= undefined)
option policy uuid
(string
= undefined)
option provider uuid
(any
= undefined)
(object
= {})
optional cpaas lifecycle headers
(string
= undefined)
optional user name
Promise<object>:
Promise resolving to a list of user's providers API connections
This function will add a subscription.
(string
= "no user uuid provided")
uuid for a star2star user
(string
= "account uuid not provided ")
account to subscribe to
(string
= "not set callback")
callback URL
(array
= [])
callback headers
(array)
optional filter criteria
(object
= {})
events to subscribe to (voice, fax, conferencing, messagin, sms, presence)
(string
= "null accessToken")
access token for cpaas systems
(string
= undefined)
optional expires date (RFC3339 format)
(object
= {})
optional microservice lifecycle trace headers
(boolean
= false)
optional high availability keep alive
Promise<object>:
Promise resolving to a data object containing a new subscription
This function will add a subscription for a custom application and event.
(string
= "null accessToken")
access token for cpaas systems
(any
= "user uuid not provided")
(string
= "app_uuid uuid not provided ")
account to subscribe to
(string
= "not set callback")
callback URL
(array
= [])
callback headers
(array)
optional filter criteria
(object
= {})
events to subscribe to (voice, fax, conferencing, messagin, sms, presence)
(string
= undefined)
optional expires date (RFC3339 format)
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a new subscription
This function will send a message to subscribers of a custom application
(string
= "null accessToken")
CPaaS access token
(string
= "account uuid not provided ")
application uuid
(string
= "null event")
even string to broadcast
(object
= {})
data to include in the broadcast
(object
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to success or failure
This function will create a custom pubsub application
(string
= "null accessToken")
CPaaS access token
(string
= "account uuid not provided ")
application_uuid
(array
= [])
events as array of objects
(string)
application name
(string)
application description
(object
= {})
application metadata
(object
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to success or failure
This function will delete a custom pubsub application
(string
= "null accessToken")
CPaaS access token
(string
= "account uuid not provided ")
application uuid
(any
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to success or failure
This function will delete a user subscriptions based on subscription id.
(string
= "no subscription uuid provided")
uuid for a star2star user
(string
= "null accessToken")
access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will return a custom pubsub application
(string
= "null accessToken")
CPaaS access token
(string
= "account uuid not provided ")
application uuid
(any
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to custom application object
This function will get a user subscription based on subscription id.
(string
= "no subscription uuid provided")
uuid for a star2star user
(string
= "null accessToken")
access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will return a list of all custom pubsub applications
(string
= "null accessToken")
CPaaS access token
(any
= "account uuid not provided ")
(any
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to custom application object
This function will return a custom subscription
(string
= "null accessToken")
CPaaS access token
(string
= "no user uuid provided")
custom user uuid
(string
= "no app uuid provided")
custom application uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= {})
optional CPaaS lifecycle headers
Promise:
promise resolving to object containing items array of subscriptions
This function will ask the cpaas pubsub service for the list of user's subscriptions.
(string
= "null accessToken")
access token for cpaas systems
(string
= "no account uuid provided")
cpaas account uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object)
optional response filters in key-value
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of subscriptions
This function will ask the cpaas pubsub service for the list of user's subscriptions.
(string
= "null accessToken")
access token for cpaas systems
(any
= 0)
(any
= 10)
(any)
(object
= {})
optional microservice lifecycle trace headers
(string
= "no user uuid provided")
uuid for a star2star user
Promise<object>:
Promise resolving to a data object containing a list of subscriptions for this user
This function will ask the cpaas pubsub service for the list of user's subscriptions.
(string
= "no user uuid provided")
uuid for a star2star user
(string
= "null accessToken")
access token for cpaas systems
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of subscriptions for this user
This function updates a subscription
(string
= "null accessToken")
access token for cpaas systems
(string)
subscription uuid
(object
= "null body")
subscription
(object
= {})
optional cpaas lifecycle headers
Promise<object>:
Promise resolving to a data object containing updated subscription
This function updates a subscription expiration date
(string
= "null accessToken")
access token for cpaas systems
(any)
uuid for a star2star user
(any
= newDate(Date.now()).toISOString())
(any
= {})
Promise<object>:
Promise resolving to a data object containing updated subscription
This function adds a relationship to a CMS resource instance row
(string
= "null accessToken")
cpaas access token
(string
= "null rowUUID")
CMS instance row uuid
(array
= [])
array off relationship uuids
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to instance object
This function adds a row to a CMS resource instance
(string
= "null accessToken")
cpaas access token
(string
= "null instanceUUID")
CMS instance uuid
(object?
= "null body")
row object
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to instance object
This function create an instance from a resource template
(string
= "null accessToken")
cpaas access token
(string
= undefined)
template uuid
(string
= undefined)
name
(string
= undefined)
description
(string
= undefined)
optional type
(object
= {})
optional microservice lifcycle headers
Promise:
promise resolving to identity object
This function deletes a CMS resource instance row.
(string
= "null accessToken")
CPaaS access token
(string
= "null instance_uuid")
resource instance uuid
(string
= "null row_id")
resource instance row id
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to a CMS instance row object
This function returns CMS resource instance rows
(string
= "null accessToken")
cpaas access token
(string
= "null uuid")
CMS instance type
(int
= 0)
instance rows offset
(int
= 100)
instance rows limit
(string
= undefined)
optional query param "include"
(string
= undefined)
optional query param "expand"
(string
= undefined)
optional query paran "reference_filter"
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to instance object
This function returns CMS resource instance rows by instance uuid
(string
= "null accessToken")
cpaas access token
(string
= "null instanceUUID")
CMS instance uuid
(int
= 0)
instance rows offset
(int
= 100)
instance rows limit
(string
= undefined)
optional query param "include"
(string
= undefined)
optional query param "expand"
(string
= undefined)
optional query paran "reference_filter"
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to instance object
This function returns a CMS resource instance row.
(string
= "null accessToken")
(string
= "null instance_uuid")
(string
= "null row_id")
(string
= "content")
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to a CMS instance row object
This function returns CMS resource instance rows
(string
= "null accessToken")
cpaas access token
(string
= undefined)
optional query param "type"
(string
= undefined)
optional query param "include"
(object
= {})
optional microservice lifcycle headers
(string
= undefined)
optional query param "account_uuid"
Promise:
promise resolving to identity object
This function register an account CMS resource template
(string
= "null accessToken")
cpaas access token
(string
= undefined)
account uuid
(string
= undefined)
name
(string
= undefined)
description
(object
= undefined)
schema
(object
= {})
optional microservice lifcycle headers
Promise:
promise resolving to identity object
This function register an user CMS resource template
(string
= "null accessToken")
cpaas access token
(string
= undefined)
user uuid
(string
= undefined)
name
(string
= undefined)
description
(object
= undefined)
schema
(object
= {})
optional microservice lifcycle headers
Promise:
promise resolving to identity object
This function searches a CMS resource.
(string
= "null accessToken")
(string
= "null resourceUUID")
resource uuid
(object
= {})
search expression object
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to a CMS instance row object
This function will create the permissions group for a resource uuid.
(string
= "null access token")
cpaas access token
(string
= "null accountUUID")
account to associate resource group to
(string
= "null resourceUUID")
resource requiring permissions groups
(string
= undefined)
resource type, object, etc.
(object
= {})
Read, Update, Delete users object
(object
= {})
optional microservice lifecycle trace headers
Promise:
promise resolving to an object containing a status message
This function will remove any permissions groups associated with a resource.
(string
= "null accessToken")
cpaas access token
(string
= "null resourceUUID")
uuid of resource
(object
= {})
optional microservice lifecycle trace headers
Promise:
promise resolving to a status message.
This function will update a resources permissions groups.
(string
= "null accessToken")
Access Token
(any
= "uuid not specified")
(any
= "null accountUUID")
(any
= undefined)
(object
= {}})
users object treated as PUT
(object
= {})
microservice lifecycle trace headers
(string
= "uuid not specified")
data object UUID
Promise<object>:
Promise resolving to confirmation of updated groups
This function lists sheduled events
(string
= "null accessToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
optional filters
(object
= {})
optional debug headers
Promise:
array of event items
This function returns the run history of previously scheduled events
(string
= "null accessToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
optional filters
(object
= {})
optional debug headers
Promise:
array of event history items
This function will schedule an event
(string
= "null accessToken")
cpaas access token
(string
= "null userUUID")
user uuid
(date
= (newDate()).toISOString())
future RFC3339 timestamp
(string
= "America/New_York")
IANA timezone
(string
= "null title")
optional schedule title
(string
= "null description")
optional schedule description
(object
= {
"type":"once"
})
frequency object
(object
= {})
action to perform at the specified schedule
(object
= {})
optional notification
(object
= {})
optional custom data to include with the event.
(object
= {})
optional debug headers
(string
= "")
optional schedule type
Promise:
scheduled event object
This function will update an event schedule
(string
= "null accessToken")
cpaas access token
(string
= "null eventUUID")
event uuid
(object
= "null body")
full event object
(object
= {})
option debug headers
Promise:
updated event object
This function will create a new short url.
(string
= 'null accessToken')
access token for cpaas systems
(object
= {})
{
"account_uuid": "string",
"analyze_content": false,
"expires_after": 0,
"max_view_count": 0,
"mode": "Proxy",
"save_content": false,
"save_preview": false,
"secure_pin": "string",
"secure_view": "None",
"short_code": "string",
"short_domain": "string",
"thumbnail": false,
"url": "string",
"user_uuid": "string"
}
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of short urls
This function will delete a short url.
(string
= 'null user uuid')
account_uuid
(string
= 'null accessToken')
access token for cpaas systems
(string
= 'notdefined')
short code for url to delete
(object
= {})
optional microservice lifecycle trace headers
Promise<empty>:
Promise resolving success or failure.
This function will get a list of all short urls.
(string
= 'null user uuid')
account_uuid
(string
= 'null accessToken')
access token for cpaas systems
(object
= {})
object of options
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object containing a list of short urls
This function returns extensions associated with a given account
(string
= "null accessToken")
cpaas access token
(string
= "null accountUUID")
cpaas account uuid
(string
= "customer")
cpaas account type
(string
= "")
optional query param "include"
(int
= 0)
items offset
(int
= 100)
items limit
(object
= {})
optional microservice lifcycle headers
Promise<object>:
promise resolving to instance object
This function will cancel a specific running workflow instance
(string
= "null access token")
(string
= "null wfTemplateUUID")
(string
= "null wfInstanceUUID")
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will delete a workflow template.
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(string
= "null version")
workflow version
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will start a new workflow with a specific return type.
(string
= "null accessToken")
CPaaS access token
(string
= "null wfTemplateUUID")
workflow template uuid
(any
= "")
(string
= "null workflowVarsPath")
json dot notation path to workflow vars to return
(string
= "application/json")
response content type
(any
= {})
(object
= {})
optional microservice lifecycle trace headers
(string
= undefined)
The Start State to start with
(object
= {})
workflow input vars
Promise:
promise resolving to data in format of response content type matching workflow vars path
This function will get a specific workflow instance
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(string
= "null wfInstanceUUID")
workflow uuid
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will get a filtered execution history for a specific workflow uuid
(string
= "null access_token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow instance uuid
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(boolean
= false)
show workflow_vars (defaults to false)
(boolean
= false)
show incoming_data (defaults to false)
(boolean
= false)
show transition results (defaults to false)
Promise:
This function will get filtered workflow vars execution history for a specific workflow uuid
(string
= "null access_token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow instance uuid
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will get filtered incoming data execution history for a specific workflow uuid
(string
= "null access_token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow instance uuid
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will get filtered transaction results execution history for a specific workflow uuid
(string
= "null access_token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow instance uuid
(any
= "null wfTransitionUUID")
(object
= {})
optional microservice lifecycle trace headers
(string
= "null instance_uuid")
workflow instance uuid
Promise:
This function returns a history of a template execution.
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(array
= undefined)
optional filters, incuding start_datetime and end_datetime (RFC3339 format), and version
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will get workflow group by uuid.
(string
= "null access token")
cpaas access token
(string
= "null wfGroupUUID")
workflow uuid
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(boolean
= false)
show master (defaults to false)
(boolean
= false)
show children (defaults to false)
(boolean
= false)
show data (defaults to false)
Promise:
This function will get workflow group child by child uuid
(string
= "null access token")
cpaas access token
(string
= "null wfGroupUUID")
workflow uuid
(string
= "null wfChildUUID")
child uuid
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will get a specific workflow template.
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(array
= undefined)
optional filters
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function lists running workflow instances by template uuid.
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(any
= undefined)
(object
= {})
optional microservice lifecycle trace headers
(string
= undefined)
optional filter by version
Promise:
This function will return a list of group objects
(string
= "null accesToken")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
object containing optional filters (start_datetime,end_datetime,template_uuid)
(object
= {})
optional microservice lifecycle trace headers
This function lists configured workflow templates
(string
= "null access token")
cpaas access token
(number
= 0)
pagination offset
(number
= 10)
pagination limit
(object
= undefined)
option filters object status or type
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function provides a way to search workflow history
(string
= "null access token")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template uuid
(string
= "2022-05-12T14:19:00.000Z")
start datetime(RFC3339 format)
(string
= "2022-05-12T14:19:00.000Z")
end datetime (RFC3339 format)
(string
= "null")
search values can be comma seperated
(number
= 50)
pagination limit ... max 50
(array
= undefined)
optional filters, version
(object
= {})
optional microservice lifecycle trace headers
Promise:
This function will start a new workflow based on the selected template.
(string
= "null accessToken")
cpaas access token
(string
= "null wfTemplateUUID")
workflow template UUID
(object
= "null body")
workflow template body
(object
= {})
optional microservice lifecycle trace headers
Promise:
Same as startWorkflow, but ms request body is composed from params
(string
= "no access token provided")
CPaaS access token
(string
= "no workflow temaplte uuid provided")
workflow template to start
(object
= {})
workflow variable to inject at start of runtime
(boolean
= true)
include workflow runtime vars in response
(boolean
= false)
run workflow sync, waiting until complete to respond to request
(string)
optional semver of workflow template to use
(string)
optional start state
(string)
optional group uuid
(string)
optional group name
(object
= {})
optional CPaaS microservice lifecycle headers
This function updates the status and data for a workflow group
(string
= "null access token")
cpaas access token
(string
= "null group uuid")
workflow group uuid
(string
= "null status")
workflow instance status [ active, complete, cancelled ]
(object
= "null data")
workflow instance data object
(object
= {})
optional microservice lifecycle trace headers
Promise:
promise resolving to updated workflow group
This function creates a new usage event.
(string
= "null accessToken")
access token for cpaas systems
(string
= "undefined")
account UUID
(string
= "undefined")
application UUID
(string
= "undefined")
event type
(string
= "undefined")
object containing metadata for this event
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to the created usage event object
This function get a CPaaS account billing cycle.
(string
= "null accessToken")
access token for cpaas systems
(string
= "undefined")
account UUID
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to the created usage event object
This function gets a completed usage report.
(string
= "null accessToken")
access token for cpaas systems
(string
= "undefined")
repor UUID
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object containing report location and details
This function gets a usage template by uuid.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null templateUUID")
usage template UUID
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a usage report template
This function lists available usage report templates.
(string
= "null accessToken")
access token for cpaas systems
(string
= 0)
pagination offset
(string
= 0)
pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a list of report templates
This function starts a usage report.
(string
= "null accessToken")
access token for cpaas systems
(string
= "null templateUUID")
report template uuid UUID
(string
= "null since")
report start
(string
= "null until")
report end
(string)
optional CPaaS account uuid
(string)
optional CPaaS application uuid
(string)
optional event type
(number)
optional offset
(number)
optional limit
(object)
optional filters expression object
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to the created usage report metadata
(any)
(any
= {})
(any
= [])
(any)
(any)
(any)
(any
= {})
This function decrypts an encrypted string into an object
(any)
(string)
key / password used to encrypt
(string)
string to be decrypted
(string
= "aes-256-cbc")
optional encryption algorithm
object:
object containing iv and decrypted object
This function decrypts an encrypted string into an object
(any)
(string)
key / password used to encrypt
(object)
object to be encrypted
(string)
optional initialization vector. string should be hex
(string
= "aes-256-cbc")
optional encryption algorithm
object:
object containing iv and encrypted strting
This function filters an API response in an "AND" format. Returned items must match filter
(object
= {})
API list response object with format {"items":[]}
(any)
(array
= [])
Array of filters to apply to API response object
object:
Response object with format {"items":[]}
This function will format a fetch error response into a standard format
(any)
object:
Returns a platform specitic reference to global runtime
object:
process.env in node, and window.s2sJsMsSdk in browser
This function will determine microservice version.
string:
the configured string value or undefined
This function returns a portion of a response in a paginated format.
(object
= {})
API list response object with format {"items":[]}
(number
= 0)
response offset
(number
= 10)
reponse items limit
object:
response object with format {"items":[],"meatadata":{}}
This function takes in a request and polls the microservice until it is ready
(string)
location of resource updates
(any)
(object)
fetch request options from original request
(object)
optional CPaaS lifecycle headers
(string
= "processing")
argument to specify expected resolution or skip polling if ready
Promise:
Promise resolved when verify func is successful.
This function will initiate proces to add a new source to the identity MFA
(string
= "null accessToken")
access token for cpaas systems
(string
= "null userUUID")
user uuid
(string
= "null type")
"EMAIL" or "SMS"
(string
= "null source")
SMS number or email to be added to MFA
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object including 'token' to use in confirm
This function will complete the process to add a new source to the identity MFA by confirming the token and code
(string
= "null accessToken")
access token for cpaas systems
(string
= "null userUUID")
user uuid
(string
= "null token")
token received from InitiateIdentityMFASetup
(string
= "null code")
code sent to the source to be added
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to an object including 'token' to use in confirm
This function will change a user's password. NOTE THAT THIS IS DIFFERENT FROM RESET PASSWORD function!!
(string
= "null access token")
access token for cpaas systems
(string?
= "null email")
user's email address
(any
= "null old_data")
(any
= "null new_data")
(object
= {})
optional microservice lifecycle trace headers
(any)
"old_data"] - user's old password
(any)
"new_data"] - user's new password
Promise<object>:
Promise resolving to a as status message; "ok" or "failed"
Type: Object
This function will list activites based on parameters .
(string
= "null access token")
(object
= {}})
optional object consisting of key and value to use in url as parameters.
(number
= 0)
pagination offset
(number
= 10)
= pagination limit
(object
= {})
optional microservice lifecycle trace headers
Promise<object>:
Promise resolving to a data object of activities
This function will get provisioned number detail information including sms enabled provider, origin campaign and help text
(string
= "null accessToken")
cpaas access token
(number?)
sms phone number
(object
= {})
microservice lifecyce headers
Promise:
Promise resolving to item details