communication

Documentation

Overview

Package communication handles interactions with external APIs for messaging, such as Africa's Talking SMS service.

Index

• Variables
• func GenerateOTP() (int, error)
• func GetDeliveryStatus(payload *models.BeemSMSDeliveryStatusPayload) (*models.BeemSMSDeliveryStatusResponse, error)
• func GetStatusMessage(code int) string
• func SendAfricasTalkingSMS(payload *models.ATSMSPayload) (*models.ATSMSResponse, error)
• func SendBeemSMS(payload *models.BeemSMSPayload) (*models.BeemSMSResponse, error)
• func SendEmail(smtpHost string, smtpPort int, username, password string, ...) error

Variables

var ATBaseURL = "https://api.africastalking.com/version1/messaging/bulk"

baseURL defines the Africa's Talking API endpoint for bulk SMS messaging. Points to the version 1 messaging endpoint.

var MessageStatusCodes = map[int]string{
	100: "Processed",
	101: "Sent",
	102: "Queued",
	401: "RiskHold",
	402: "InvalidSenderId",
	403: "InvalidPhoneNumber",
	404: "UnsupportedNumberType",
	405: "InsufficientBalance",
	406: "UserInBlacklist",
	407: "CouldNotRoute",
	409: "DoNotDisturbRejection",
	500: "InternalServerError",
	501: "GatewayError",
	502: "RejectedByGateway",
}

MessageStatusCodes maps Africa's Talking API status codes to human-readable messages. Provides descriptions for common success and error states.

Functions

func GenerateOTP

func GenerateOTP() (int, error)

GenerateOTP generates a secure 6-digit One-Time Password (OTP). Returns the OTP and an error (if any occurs during generation).

func GetDeliveryStatus

func GetDeliveryStatus(payload *models.BeemSMSDeliveryStatusPayload) (*models.BeemSMSDeliveryStatusResponse, error)

GetDeliveryStatus retrieves the delivery status of an SMS from the Beem API. Sends a GET request with query parameters and parses the response. Returns the delivery status response or an error if the request fails.

func GetStatusMessage

func GetStatusMessage(code int) string

GetStatusMessage retrieves the human-readable message for a given status code. Returns the corresponding message from MessageStatusCodes or a default unknown message.

func SendAfricasTalkingSMS

func SendAfricasTalkingSMS(payload *models.ATSMSPayload) (*models.ATSMSResponse, error)

SendAfricasTalkingSMS sends a bulk SMS request to the Africa's Talking API. Marshals the SMS payload, sends a POST request, and parses the response. Returns the SMS response or an error if the request fails.

func SendBeemSMS

func SendBeemSMS(payload *models.BeemSMSPayload) (*models.BeemSMSResponse, error)

SendBeemSMS sends an SMS request to the Beem API. Constructs the request payload, sends a POST request, and parses the response. Returns the SMS response or an error if the request fails.

func SendEmail

func SendEmail(smtpHost string, smtpPort int, username, password string, InsecureSkipVerify bool, details models.EmailDetails) error

SendEmail sends an email using the provided SMTP server details and email content. Configures an email with sender, recipients, subject, body, and attachments. Connects to the SMTP server and sends the email, supporting TLS configuration. Returns an error if the email sending fails, otherwise nil.