API Documentation
\
CpaasSdk
Resources

\CpaasSdk\ResourcesConversation

CPaaS conversation.

Summary

Methods
Properties
Constants
create_message()
get_messages()
get_status()
get_messages_in_thread()
delete_message()
get_subscriptions()
get_subscription()
subscribe()
unsubscribe()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

create_message()

create_message(array  $params = null)

Send a new outbound message

Parameters

array $params

Single parameter to hold all options.

    


  • $params['type']                string   
    Type of conversation.Possible value(s) - sms. Check conversation->types for more options.
    • 

  • $params['sender_address']      string   
    Sender address information, basically the from address. E164 formatted DID number passed as a value, which is owned by the user. If the user wants to let CPaaS uses the default assigned DID number, then this field should have "default" as it's value.
    • 

  • $params['destination_address'] string   
    Indicates which DID number(s) used as destination for this SMS.
    

  • $params['message']             string   
    SMS text message.

get_messages()

get_messages(array  $params = null)

Gets all messages.

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']                   string 
    Type of conversation. Possible value(s) - sms. Check conversation->types for more options.
    • 

  • $params['remote_address']         string optional 
    Remote address information, information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
    • 

  • $params['local_address]           string optional 
    Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
    • 

  • $params['query']                  array  optional 
    To hold all query related parameter.
    • 

  • $params['query']['name']          string optional 
    Performs search operation on first_name and last_name fields.
    • 

  • $params['query']['first_name']    string optional 
    Performs search for the first_name field of the directory items.
    • 

  • $params['query']['last_name']     string optional 
    Performs search for the last_name field of the directory items.
    • 

  • $params['query']['user_name']     string optional 
    Performs search for the user_name field of the directory items.
    • 

  • $params['query']['phone_number']  string optional 
    Performs search for the fields containing a phone number, like businessPhoneNumber, homePhoneNumber, mobile, pager, fax.
    • 

  • $params['query']['order']         string optional 
    Ordering the contact results based on the requested sortBy value, order query parameter should be accompanied by sortBy query parameter.
    • 

  • $params['query']['sort_by']       string optional 
    SortBy value is used to detect sorting the contact results based on which attribute. If order is not provided with that, ascending order is used.
    • 

  • $params['query']['max']           int    optional 
    Maximum number of contact results that has been requested from CPaaS for this query.
    • 

  • $params['query']['next']          string optional 
    Pointer for the next chunk of contacts, should be gathered from the previous query results.
    •

get_status()

get_status(array  $params = null)

Read a conversation message status

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']           string   
    Type of conversation. Possible value(s) -  sms. Check conversation->types for more options.
    • 

  • $params['remote_address'] string   
    Remote address information, information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
    • 

  • $params['local_address']  string   
    Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
    • 

  • $params['message_id']     string   
    Identification of the SMS message.
    •

get_messages_in_thread()

get_messages_in_thread(array  $params = null)

Read all messages in a thread

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']                        string 
    Type of conversation. Possible value(s) - sms. Check conversation->types for more options.
    • 

  • $params['remote_address']              string 
    Remote address information, information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
    • 

  • $params['local_address']               string 
    Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
    • 

  • $params['query']                       array  optional
    To hold all query related parameter.
    • 

  • $params['query']['max']                int    optional
    Maximum number of contact results that has been requested from CPaaS for this query.
    • 

  • $params['query']['next']               string optional
    Filters the messages or threads having messages that are not received by the user yet.
    • 

  • $params['query']['last_message_time']  string optional
    Filters the messages or threads having messages that are sent/received after provided Epoch time.
    •

delete_message()

delete_message(array  $params = null)

Delete conversation message

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']           string   
    Type of conversation. Possible value(s) -  sms. Check conversation->types for more options.
    • 

  • $params['remote_address'] string   
    Remote address information, information while retrieving the SMS history, basically the destination telephone number that user exchanged SMS before. E164 formatted DID number passed as a value.
    • 

  • $params['local_address']  string   
    Local address information while retrieving the SMS history, basically the source telephone number that user exchanged SMS before.
    • 

  • $params['message_id']     string   
    Identification of the SMS message.
    •

get_subscriptions()

get_subscriptions(array  $params = null)

Read all active subscriptions

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']           string   
    Type of conversation. Possible value(s) - sms. Check conversation->types for more options.
    •

get_subscription()

get_subscription(array  $params = null)

Read active subscription.

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']             string   
    Type of conversation. Possible value(s) -  sms. Check conversation->types for more options.
    • 

  • $params['subscription_id']  string   
    Resource ID of the subscription.
    •

subscribe()

subscribe(array  $params = null)

Create a new subscription.

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']                 string   
    Type of conversation. Possible value(s) -  sms. Check conversation->types for more options.
    • 

  • $params['webhook_url']          string   
    HTTPS URL that is present in your application server which is accessible from the public web where the notifications should be sent to. Note: Should be a POST endpoint.
    • 

  • $params['destination_address']  string   optional 
    The address that incoming messages are received for this subscription. If does not exist, CPaaS uses the default assigned DID number to subscribe against. It is suggested to provide the intended E164 formatted DID number within this parameter.
    •

unsubscribe()

unsubscribe(array  $params = null)

Unsubscription from conversation notification

Parameters

array $params

Single parameter to hold all options.

    

  • $params['type']             string   
    Type of conversation. Possible value(s) -  sms. Check conversation->types for more options.
    • 

  • $params['subscription_id']  string   
    Resource ID of the subscription.
    •