Skip to content

Latest commit

 

History

History
282 lines (212 loc) · 8.33 KB

SmsApi.md

File metadata and controls

282 lines (212 loc) · 8.33 KB
Raw

org.egoi.client.api.Api.SmsApi

All URIs are relative to https://api.egoiapp.com

Method HTTP request Description
ActionSendSms POST /campaigns/sms/{campaign_hash}/actions/send Send sms message
CreateSmsCampaign POST /campaigns/sms Create new sms campaign
PatchSmsCampaign PATCH /campaigns/sms/{campaign_hash} Update a specific sms campaign

ActionSendSms

AcceptedResponse ActionSendSms (string campaignHash, CampaignSmsSendRequest campaignSmsSendRequest)

Send sms message

Deploys and sends an sms message

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class ActionSendSmsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new SmsApi(Configuration.Default);
            var campaignHash = campaignHash_example;  // string | ID of the Campaign
            var campaignSmsSendRequest = new CampaignSmsSendRequest(); // CampaignSmsSendRequest | Parameters for the 'send sms' action

            try
            {
                // Send sms message
                AcceptedResponse result = apiInstance.ActionSendSms(campaignHash, campaignSmsSendRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling SmsApi.ActionSendSms: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
campaignHash string ID of the Campaign
campaignSmsSendRequest CampaignSmsSendRequest Parameters for the 'send sms' action

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSmsCampaign

HashcodeCampaign CreateSmsCampaign (SmsCampaign smsCampaign)

Create new sms campaign

Create a new sms campaign

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class CreateSmsCampaignExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new SmsApi(Configuration.Default);
            var smsCampaign = new SmsCampaign(); // SmsCampaign | Parameters for the Sms Campaign

            try
            {
                // Create new sms campaign
                HashcodeCampaign result = apiInstance.CreateSmsCampaign(smsCampaign);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling SmsApi.CreateSmsCampaign: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
smsCampaign SmsCampaign Parameters for the Sms Campaign

Return type

HashcodeCampaign

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchSmsCampaign

HashcodeCampaign PatchSmsCampaign (string campaignHash, SmsCampaignPatchRequest smsCampaignPatchRequest)

Update a specific sms campaign

Update sms campaign

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class PatchSmsCampaignExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new SmsApi(Configuration.Default);
            var campaignHash = campaignHash_example;  // string | ID of the Campaign
            var smsCampaignPatchRequest = new SmsCampaignPatchRequest(); // SmsCampaignPatchRequest | Parameters for the Sms Campaign

            try
            {
                // Update a specific sms campaign
                HashcodeCampaign result = apiInstance.PatchSmsCampaign(campaignHash, smsCampaignPatchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling SmsApi.PatchSmsCampaign: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
campaignHash string ID of the Campaign
smsCampaignPatchRequest SmsCampaignPatchRequest Parameters for the Sms Campaign

Return type

HashcodeCampaign

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

[Back to top] [Back to API list] [Back to Model list] [Back to README]