feat: update iransmspanel gateway to support bulk SMS and template #408
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ssaging ## Changes ### Persian Bulk SMS Gateway Updates - Updated gateway to use Persian Bulk SMS API (persianbulk.com, formerly iransmspanel.ir) - Updated API base URL to https://developer.persianbulk.com - Updated documentation and help text to reflect new branding ### Bulk SMS Support - Implemented SendArray endpoint for efficient bulk message delivery - Changed from comma-separated string to array format for recipients - All messages now use bulk endpoint by default for better performance ### Template SMS Support - Added SendTemplateSMS() public method for direct template message sending - Implemented auto-detection for template messages in SendSMS() method - Added support for multiple tokens (token, token2, token3, etc.) - Template format: "template:TEMPLATE_ID|token:VALUE|date:VALUE|token2:VALUE2" - Flexible token passing: string, array, or additional parameters ### Features - Single recipient and multiple recipient support - Optional date parameter for templates - Comprehensive error handling and logging - Backward compatible with existing code - WordPress filters maintained (wp_sms_from, wp_sms_to, wp_sms_msg) ## API Endpoints Used - `/sms/SendArray` - Bulk SMS sending - `/sms/Send/pattern` - Template SMS sending - `/sms/Balance` - Account credit/balance retrieval ## Breaking Changes None. All existing functionality remains compatible. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Contributor
WalkthroughThe PR updates the Iran SMS Panel gateway integration to use Persian Bulk SMS API. This includes remapping the gateway domain from iransmspanel.ir to persianbulk.com in the global gateway registry, and comprehensively refactoring the gateway class to migrate from legacy socket/cURL flows to Persian Bulk's API-based endpoints with template support and API key authentication. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
includes/class-wpsms-gateway.php(1 hunks)includes/gateways/class-wpsms-gateway-iransmspanel.php(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
includes/gateways/class-wpsms-gateway-iransmspanel.php (1)
includes/class-wpsms-gateway.php (7)
help(995-1005)__construct(380-411)from(1010-1016)response(987-990)request(1134-1139)status(925-982)log(546-567)
🔇 Additional comments (1)
includes/class-wpsms-gateway.php (1)
817-817: LGTM: gateway mapping now reflects Persian BulkThe slug now points to persianbulk.com, keeping the registry consistent with the refactored gateway class.
Comment on lines
+153
to
+169
| 'sender' => $receptor, // Recipient number | ||
| 'template' => $template, // Template ID | ||
| ]; | ||
|
|
||
| // Handle token parameter - supports string or array | ||
| if (is_array($token)) { | ||
| // Multiple tokens provided as array | ||
| // Try format 1: token, token2, token3, etc. | ||
| $body['token'] = $token[0] ?? ''; | ||
| for ($i = 1; $i < count($token); $i++) { | ||
| $body['token' . ($i + 1)] = $token[$i]; | ||
| } | ||
| } else { | ||
| // Single token as string | ||
| $body['token'] = $token; | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
Fix template payload: recipient sent as sender
Both SendTemplateSMS() and sendTemplateMessage() populate the request body with 'sender' => $receptor and never send a receptor field. Persian Bulk expects the sender line ID and the recipient number separately; with the current mapping the API receives no recipient and uses the target number as the sender, so template messages will fail. Please swap the assignments so the sender line comes from $this->from and add the missing receptor.
Apply this diff:
- 'sender' => $receptor,
- 'template' => $template,
+ 'sender' => $this->from,
+ 'receptor' => $receptor,
+ 'template' => $template,- 'sender' => $receptor,
- 'template' => $data['template'],
- 'token' => $data['token'],
+ 'sender' => $this->from,
+ 'receptor' => $receptor,
+ 'template' => $data['template'],
+ 'token' => $data['token'],Also applies to: 249-253
🤖 Prompt for AI Agents
In includes/gateways/class-wpsms-gateway-iransmspanel.php around lines 153 to
169 (also apply same change to lines ~249-253), the request body maps the
recipient into the 'sender' field and omits 'receptor'; change the payload so
'sender' is set to $this->from (the SMS line ID) and add a 'receptor' =>
$receptor entry to include the recipient number, keeping the existing 'template'
and token handling intact; apply the identical swap/addition for the other
occurrence at lines ~249-253.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Refactor iransmspanel gateway based on new API https://developer.persianbulk.com
Submission Review Guidelines:
CHANGELOG.md.Type of change
Summary by CodeRabbit
New Features
Chores