Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| sa50-00 [2024/01/23 19:33] – [Setting Up] Justin Willey | sa50-00 [2024/01/23 20:07] (current) – [Setting Up] Justin Willey | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| ===== Requirements ===== | ===== Requirements ===== | ||
| Line 13: | Line 13: | ||
| * Generate API key, secret & token in SMSWorks account website | * Generate API key, secret & token in SMSWorks account website | ||
| - | * Choose a UserName (normally SMSWorks) and Password that will be used by SMSWorks to call a WebHook provided by IQXHub that will receive and process incoming text messages from SMSWorks. | + | * Choose a UserName (normally SMSWorks) and Password that will be used by SMSWorks to call a WebHook provided by IQXHub that will receive and process incoming text messages from SMSWorks. (NB these are not a user name and password from the SMSWorks account - they are ones we set so that SMSWorks can authenticate with us). |
| - | * Populate the SMSWorksConfig table with the Token (from SMSWorks) and the UserName, Password chosen above. | + | * Populate the SMSWorksConfig table with the Token (from SMSWorks) and the UserName, Password chosen above. |
| + | </ | ||
| * Configure the functions OutgoingSMSCETypes & CustomSMSHTTPRequest | * Configure the functions OutgoingSMSCETypes & CustomSMSHTTPRequest | ||
| * Upload the IncomingSMS.xml job to Maintenance | Databases Setup | System Jobs and Reports | * Upload the IncomingSMS.xml job to Maintenance | Databases Setup | System Jobs and Reports | ||
| * Use the Create Hub For Web Services button in Maintenance | IQXWeb Setup | Profiles to create a User (normally SMSWorks as above) and User Class for a user matching the details (including password) set up in SMSWorksConfig above. | * Use the Create Hub For Web Services button in Maintenance | IQXWeb Setup | Profiles to create a User (normally SMSWorks as above) and User Class for a user matching the details (including password) set up in SMSWorksConfig above. | ||
| * In Maintenance | IQXWeb Setup | User Classes | * In Maintenance | IQXWeb Setup | User Classes | ||
| - | * In the SMSWorks Account | Reply Numbers - set the response URL eg: https:// | + | * In the SMSWorks Account | Reply Numbers - set the response URL eg: https:// |
| * In IQX Maintenance | Agency Setup - ensure that Contact Event Types are set up for SM / text messaging - you probably want incoming and outgoing. | * In IQX Maintenance | Agency Setup - ensure that Contact Event Types are set up for SM / text messaging - you probably want incoming and outgoing. | ||
| * Check that the Applicant and other phone types for mobile numbers include the **S** Capability. | * Check that the Applicant and other phone types for mobile numbers include the **S** Capability. | ||
| - | * In IQX Maintenance | General Settings set or check the following settings: | + | * In IQX Maintenance | General Settings set or check the following settings: |
| - | | + | |
| * Against the IQX User record for users who are going to be using Two-Way SMS, set one of the available incoming mobile numbers on the SMS Number view. (This must be done manually using numbers set up on the SMSWorks account web site , the buttons GetNewNumber and Release Number do not currently work). | * Against the IQX User record for users who are going to be using Two-Way SMS, set one of the available incoming mobile numbers on the SMS Number view. (This must be done manually using numbers set up on the SMSWorks account web site , the buttons GetNewNumber and Release Number do not currently work). | ||